Metadata

This page documents the metadata classes used for audio/video file metadata (tags, cover art, etc.).

Metadata

class avblocks.metadata.Metadata

Bases: IImmutable

Metadata describes meta information that is part of an audio or video file.

It can hold various textual information and images.

property attributes: MetaAttributeList

A modifiable collection with all metadata attributes.

The default value of this property is an empty collection which can be modified but it cannot be replaced.

clone() → Metadata

Creates a deep copy of this object.

Returns:

A new Metadata object

property immutable: bool

Returns whether the object is immutable. An immutable object cannot be modified and all modifying methods fail to produce a result.

An immutable object can be modified by the AVBlocks library. Object immutability spreads to all nested objects. Therefore it is not possible to add/set an immutable object to a mutable object. When cloned an immutable object becomes mutable.

property pictures: MetaPictureList

A modifiable collection with all metadata pictures.

The default value of this property is an empty collection which can be modified but it cannot be replaced.

MetaAttribute

class avblocks.meta_attribute.MetaAttribute

Bases: IImmutable

MetaAttribute describes a metadata attribute (tag) that is part of an audio or video file.

clone() → MetaAttribute

Creates a deep copy of this object.

Returns:

A new MetaAttribute object

property immutable: bool

Returns whether the object is immutable. An immutable object cannot be modified and all modifying methods fail to produce a result.

An immutable object can be modified by the AVBlocks library. Object immutability spreads to all nested objects. Therefore it is not possible to add/set an immutable object to a mutable object. When cloned an immutable object becomes mutable.

property name: str | None

Attribute name (tag).

See the Meta class for common attribute names.

property value: str | None

Attribute value as a free text.

MetaPicture

class avblocks.meta_picture.MetaPicture

Bases: IImmutable

MetaPicture describes a meta image that is part of an audio or video file.

property bytes: bytes | None

Image bytes.

The image is a jpeg, png or another image type.

clone() → MetaPicture

Creates a deep copy of this object.

Returns:

A new MetaPicture object

property description: str | None

Picture description as a free text.

property immutable: bool

Returns whether the object is immutable. An immutable object cannot be modified and all modifying methods fail to produce a result.

An immutable object can be modified by the AVBlocks library. Object immutability spreads to all nested objects. Therefore it is not possible to add/set an immutable object to a mutable object. When cloned an immutable object becomes mutable.

property mime_type: str | None

Picture mime type.

property picture_type: int

Picture type such as front cover, back cover, artist, etc.