TransparentMeta
The basics
What is TransparentMeta?
What problem does TransparentMeta solve?
Who should use TransparentMeta?
How TransparentMeta works
Guiding principles
FAQs
Key concepts
Audio formats supported
Metadata
Cryptographic signature
Learning
Installation
Getting started
Examples
Tutorials
Code reference
transparentmeta
TransparentMeta
Index
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
L
|
M
|
N
|
P
|
R
|
S
|
T
|
U
|
V
|
W
_
__init__() (transparentmeta.crypto.exceptions.NotEd25519KeyError method)
(transparentmeta.crypto.hasher.Hasher method)
(transparentmeta.crypto.signature_verifier.SignatureVerifier method)
(transparentmeta.crypto.signer.Signer method)
(transparentmeta.request.exceptions.InvalidAudioFileError method)
(transparentmeta.request.exceptions.NoWritePermissionsError method)
(transparentmeta.request.exceptions.WAVTooLargeError method)
(transparentmeta.result.result.ReadResult method)
(transparentmeta.result.result.Result method)
(transparentmeta.sdk.transparent_metadata_reader.TransparentMetadataReader method)
(transparentmeta.sdk.transparent_metadata_writer.TransparentMetadataWriter method)
(transparentmeta.sdk.TransparentMetadataReader method)
(transparentmeta.sdk.TransparentMetadataWriter method)
(transparentmeta.serialization.metadata_serializer.MetadataSerializer method)
(transparentmeta.use_case.exceptions.UnsupportedAudioFormatError method)
(transparentmeta.use_case.read.metadata_reader.AudioFileDataReading method)
(transparentmeta.use_case.read.metadata_reader.MetadataReader method)
(transparentmeta.use_case.read.read_use_case.ReadUseCase method)
(transparentmeta.use_case.read.reader_selector.ReaderSelector method)
(transparentmeta.use_case.write.metadata_writer.MetadataWriter method)
(transparentmeta.use_case.write.write_use_case.WriteUseCase method)
(transparentmeta.use_case.write.writer_selector.WriterSelector method)
(transparentmeta.utils.exceptions.InvalidHexadecimalStringError method)
A
additional_info (transparentmeta.entity.metadata.Metadata attribute)
,
[1]
AI_ASSISTED (transparentmeta.entity.metadata.AIUsageLevel attribute)
,
[1]
AI_GENERATED (transparentmeta.entity.metadata.AIUsageLevel attribute)
,
[1]
ai_usage_level (transparentmeta.entity.metadata.Metadata attribute)
,
[1]
AIUsageLevel (class in transparentmeta.entity.metadata)
ASCII (transparentmeta.crypto.character_encoding.CharacterEncoding attribute)
AudioFileDataReading (class in transparentmeta.use_case.read.metadata_reader)
B
build_metadata_reader() (in module transparentmeta.use_case.read.factory)
build_metadata_writer() (in module transparentmeta.use_case.write.factory)
build_read_use_case() (in module transparentmeta.use_case.read.factory)
build_transparent_metadata_reader() (in module transparentmeta.sdk)
(in module transparentmeta.sdk.factory)
build_transparent_metadata_writer() (in module transparentmeta.sdk)
(in module transparentmeta.sdk.factory)
build_write_use_case() (in module transparentmeta.use_case.write.factory)
C
character_encoding (transparentmeta.crypto.signature_verifier.SignatureVerifier attribute)
(transparentmeta.crypto.signer.Signer attribute)
CharacterEncoding (class in transparentmeta.crypto.character_encoding)
company (transparentmeta.entity.metadata.Metadata attribute)
,
[1]
configure_logging() (in module transparentmeta.logger_config)
content_id (transparentmeta.entity.metadata.Metadata attribute)
,
[1]
convert_private_key_to_hex() (in module transparentmeta.crypto.key_management)
convert_public_key_to_hex() (in module transparentmeta.crypto.key_management)
create_id3_tags_in_file_if_none_exists() (in module transparentmeta.utils.metadata_tags_utils)
created_at (transparentmeta.entity.metadata.Metadata attribute)
,
[1]
D
decode_bytes_to_hexadecimal_string() (in module transparentmeta.utils.encoding_utils)
deserialize() (transparentmeta.serialization.metadata_serializer.MetadataSerializer method)
does_file_contain_any_id3_tags() (in module transparentmeta.utils.metadata_tags_utils)
E
encode_hexadecimal_string_to_bytes() (in module transparentmeta.utils.encoding_utils)
encode_string_to_bytes() (in module transparentmeta.utils.encoding_utils)
error (transparentmeta.result.result.Result attribute)
,
[1]
F
filepath (transparentmeta.request.read_request.ReadRequest attribute)
,
[1]
(transparentmeta.request.write_request.WriteRequest attribute)
,
[1]
G
generate_key_pair() (in module transparentmeta.crypto.key_management)
get_file_extension() (in module transparentmeta.utils.file_utils)
get_file_size() (in module transparentmeta.utils.file_utils)
get_reader() (transparentmeta.use_case.read.reader_selector.ReaderSelector method)
get_writer() (transparentmeta.use_case.write.writer_selector.WriterSelector method)
H
hash() (transparentmeta.crypto.hasher.Hasher method)
hash_algorithm_name (transparentmeta.crypto.hasher.Hasher attribute)
Hasher (class in transparentmeta.crypto.hasher)
HUMAN_CREATED (transparentmeta.entity.metadata.AIUsageLevel attribute)
,
[1]
I
InvalidAudioFileError
InvalidHexadecimalStringError
is_signature_valid() (transparentmeta.crypto.signature_verifier.SignatureVerifier method)
is_success (transparentmeta.result.result.Result attribute)
,
[1]
(transparentmeta.use_case.read.metadata_reader.AudioFileDataReading attribute)
,
[1]
L
load_private_key_from_hex_string() (in module transparentmeta.crypto.key_management)
load_private_key_from_pem_file() (in module transparentmeta.crypto.key_management)
load_public_key_from_hex_string() (in module transparentmeta.crypto.key_management)
load_public_key_from_pem_file() (in module transparentmeta.crypto.key_management)
M
Metadata (class in transparentmeta.entity.metadata)
metadata (transparentmeta.request.write_request.WriteRequest attribute)
,
[1]
(transparentmeta.result.result.ReadResult attribute)
,
[1]
(transparentmeta.use_case.read.metadata_reader.AudioFileDataReading attribute)
,
[1]
metadata_reader (transparentmeta.use_case.read.read_use_case.ReadUseCase attribute)
(transparentmeta.use_case.read.read_use_case.ReadUseCase property)
metadata_readers (transparentmeta.use_case.read.reader_selector.ReaderSelector attribute)
metadata_serializer (transparentmeta.use_case.read.read_use_case.ReadUseCase attribute)
(transparentmeta.use_case.write.write_use_case.WriteUseCase attribute)
metadata_writer (transparentmeta.use_case.write.write_use_case.WriteUseCase attribute)
(transparentmeta.use_case.write.write_use_case.WriteUseCase property)
metadata_writers (transparentmeta.use_case.write.writer_selector.WriterSelector attribute)
MetadataReader (class in transparentmeta.use_case.read.metadata_reader)
MetadataSerializer (class in transparentmeta.serialization.metadata_serializer)
MetadataWriter (class in transparentmeta.use_case.write.metadata_writer)
model (transparentmeta.entity.metadata.Metadata attribute)
,
[1]
model_config (transparentmeta.entity.metadata.Metadata attribute)
(transparentmeta.request.read_request.ReadRequest attribute)
(transparentmeta.request.write_request.WriteRequest attribute)
module
transparentmeta
transparentmeta.crypto
transparentmeta.crypto.character_encoding
transparentmeta.crypto.exceptions
transparentmeta.crypto.hasher
transparentmeta.crypto.key_management
transparentmeta.crypto.signature_verifier
transparentmeta.crypto.signer
transparentmeta.entity
transparentmeta.entity.metadata
transparentmeta.logger_config
transparentmeta.request
transparentmeta.request.exceptions
transparentmeta.request.file_validators
transparentmeta.request.read_request
transparentmeta.request.write_request
transparentmeta.result
transparentmeta.result.result
transparentmeta.sdk
transparentmeta.sdk.factory
transparentmeta.sdk.transparent_metadata_reader
transparentmeta.sdk.transparent_metadata_writer
transparentmeta.serialization
transparentmeta.serialization.metadata_serializer
transparentmeta.use_case
transparentmeta.use_case.constants
transparentmeta.use_case.exceptions
transparentmeta.use_case.read
transparentmeta.use_case.read.factory
transparentmeta.use_case.read.metadata_reader
transparentmeta.use_case.read.mp3_metadata_reader
transparentmeta.use_case.read.read_use_case
transparentmeta.use_case.read.reader_selector
transparentmeta.use_case.read.wav_metadata_reader
transparentmeta.use_case.types
transparentmeta.use_case.write
transparentmeta.use_case.write.factory
transparentmeta.use_case.write.metadata_writer
transparentmeta.use_case.write.mp3_metadata_writer
transparentmeta.use_case.write.wav_metadata_writer
transparentmeta.use_case.write.write_use_case
transparentmeta.use_case.write.writer_selector
transparentmeta.utils
transparentmeta.utils.encoding_utils
transparentmeta.utils.exceptions
transparentmeta.utils.file_utils
transparentmeta.utils.metadata_tags_utils
MP3MetadataReader (class in transparentmeta.use_case.read.mp3_metadata_reader)
MP3MetadataWriter (class in transparentmeta.use_case.write.mp3_metadata_writer)
N
NotEd25519KeyError
NoWritePermissionsError
P
private_key (transparentmeta.crypto.signer.Signer attribute)
private_key_id (transparentmeta.entity.metadata.Metadata attribute)
,
[1]
public_key (transparentmeta.crypto.signature_verifier.SignatureVerifier attribute)
R
read() (transparentmeta.sdk.transparent_metadata_reader.TransparentMetadataReader method)
(transparentmeta.sdk.TransparentMetadataReader method)
(transparentmeta.use_case.read.metadata_reader.MetadataReader method)
(transparentmeta.use_case.read.read_use_case.ReadUseCase method)
read_use_case (transparentmeta.sdk.transparent_metadata_reader.TransparentMetadataReader attribute)
(transparentmeta.sdk.TransparentMetadataReader attribute)
reader_selector (transparentmeta.sdk.transparent_metadata_reader.TransparentMetadataReader attribute)
(transparentmeta.sdk.TransparentMetadataReader attribute)
ReaderSelector (class in transparentmeta.use_case.read.reader_selector)
ReadRequest (class in transparentmeta.request.read_request)
ReadResult (class in transparentmeta.result.result)
ReadUseCase (class in transparentmeta.use_case.read.read_use_case)
Result (class in transparentmeta.result.result)
S
save_private_key_to_pem_file() (in module transparentmeta.crypto.key_management)
save_public_key_to_pem_file() (in module transparentmeta.crypto.key_management)
serialize() (transparentmeta.serialization.metadata_serializer.MetadataSerializer method)
set_txxx_id3_tag() (in module transparentmeta.utils.metadata_tags_utils)
sign() (transparentmeta.crypto.signer.Signer method)
signature (transparentmeta.use_case.read.metadata_reader.AudioFileDataReading attribute)
,
[1]
signature_field (transparentmeta.use_case.read.metadata_reader.MetadataReader attribute)
(transparentmeta.use_case.write.metadata_writer.MetadataWriter attribute)
signature_verifier (transparentmeta.use_case.read.read_use_case.ReadUseCase attribute)
SignatureVerifier (class in transparentmeta.crypto.signature_verifier)
Signer (class in transparentmeta.crypto.signer)
signer (transparentmeta.use_case.write.write_use_case.WriteUseCase attribute)
T
transparency_metadata_field (transparentmeta.use_case.read.metadata_reader.MetadataReader attribute)
(transparentmeta.use_case.write.metadata_writer.MetadataWriter attribute)
transparentmeta
module
transparentmeta.crypto
module
transparentmeta.crypto.character_encoding
module
transparentmeta.crypto.exceptions
module
transparentmeta.crypto.hasher
module
transparentmeta.crypto.key_management
module
transparentmeta.crypto.signature_verifier
module
transparentmeta.crypto.signer
module
transparentmeta.entity
module
transparentmeta.entity.metadata
module
transparentmeta.logger_config
module
transparentmeta.request
module
transparentmeta.request.exceptions
module
transparentmeta.request.file_validators
module
transparentmeta.request.read_request
module
transparentmeta.request.write_request
module
transparentmeta.result
module
transparentmeta.result.result
module
transparentmeta.sdk
module
transparentmeta.sdk.factory
module
transparentmeta.sdk.transparent_metadata_reader
module
transparentmeta.sdk.transparent_metadata_writer
module
transparentmeta.serialization
module
transparentmeta.serialization.metadata_serializer
module
transparentmeta.use_case
module
transparentmeta.use_case.constants
module
transparentmeta.use_case.exceptions
module
transparentmeta.use_case.read
module
transparentmeta.use_case.read.factory
module
transparentmeta.use_case.read.metadata_reader
module
transparentmeta.use_case.read.mp3_metadata_reader
module
transparentmeta.use_case.read.read_use_case
module
transparentmeta.use_case.read.reader_selector
module
transparentmeta.use_case.read.wav_metadata_reader
module
transparentmeta.use_case.types
module
transparentmeta.use_case.write
module
transparentmeta.use_case.write.factory
module
transparentmeta.use_case.write.metadata_writer
module
transparentmeta.use_case.write.mp3_metadata_writer
module
transparentmeta.use_case.write.wav_metadata_writer
module
transparentmeta.use_case.write.write_use_case
module
transparentmeta.use_case.write.writer_selector
module
transparentmeta.utils
module
transparentmeta.utils.encoding_utils
module
transparentmeta.utils.exceptions
module
transparentmeta.utils.file_utils
module
transparentmeta.utils.metadata_tags_utils
module
TransparentMetadataReader (class in transparentmeta.sdk)
(class in transparentmeta.sdk.transparent_metadata_reader)
TransparentMetadataWriter (class in transparentmeta.sdk)
(class in transparentmeta.sdk.transparent_metadata_writer)
U
UnsupportedAudioFormatError
user_id (transparentmeta.entity.metadata.Metadata attribute)
,
[1]
UTF8 (transparentmeta.crypto.character_encoding.CharacterEncoding attribute)
V
validate_audio_file_is_functioning() (in module transparentmeta.request.file_validators)
validate_audio_format_is_supported() (in module transparentmeta.request.file_validators)
validate_file_exists() (in module transparentmeta.request.file_validators)
validate_file_has_write_permissions() (in module transparentmeta.request.file_validators)
validate_filepath() (transparentmeta.request.read_request.ReadRequest class method)
(transparentmeta.request.write_request.WriteRequest class method)
validate_wav_file_is_not_too_large() (in module transparentmeta.request.file_validators)
W
WAVMetadataReader (class in transparentmeta.use_case.read.wav_metadata_reader)
WAVMetadataWriter (class in transparentmeta.use_case.write.wav_metadata_writer)
WAVTooLargeError
write() (transparentmeta.sdk.transparent_metadata_writer.TransparentMetadataWriter method)
(transparentmeta.sdk.TransparentMetadataWriter method)
(transparentmeta.use_case.write.metadata_writer.MetadataWriter method)
(transparentmeta.use_case.write.mp3_metadata_writer.MP3MetadataWriter method)
(transparentmeta.use_case.write.wav_metadata_writer.WAVMetadataWriter method)
(transparentmeta.use_case.write.write_use_case.WriteUseCase method)
write_use_case (transparentmeta.sdk.transparent_metadata_writer.TransparentMetadataWriter attribute)
(transparentmeta.sdk.TransparentMetadataWriter attribute)
writer_selector (transparentmeta.sdk.transparent_metadata_writer.TransparentMetadataWriter attribute)
(transparentmeta.sdk.TransparentMetadataWriter attribute)
WriteRequest (class in transparentmeta.request.write_request)
WriterSelector (class in transparentmeta.use_case.write.writer_selector)
WriteUseCase (class in transparentmeta.use_case.write.write_use_case)