LyricsTag class
LyricsTag class
Represents Lyrics3 v2.00 metadata. Please find more information at http://id3.org/Lyrics3v2.
Inheritance: LyricsTag →
CustomPackage →
MetadataPackage
The LyricsTag type exposes the following members:
Constructors
| Constructor | Description |
|---|---|
__init__(self) |
Initializes a new instance of the LyricsTag class. |
Properties
| Property | Description |
|---|---|
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| lyrics | Gets or sets the lyrics.
This value is represented by the LYR field. |
| additional_info | Gets or sets the additional information.
This value is represented by the INF field. |
| author | Gets or sets the author.
This value is represented by the AUT field. |
| album | Gets or sets the album name.
This value is represented by the EAL field. |
| artist | Gets or sets the artist name.
This value is represented by the EAR field. |
| track | Gets or sets the track title.
This value is represented by the ETT field. |
Methods
| Method | Description |
|---|---|
contains(self, property_name) |
Determines whether the package contains a metadata property with the specified name. |
find_properties(self, specification) |
Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well. |
update_properties(self, specification, value) |
Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well. |
remove_properties(self, specification) |
Removes metadata properties satisfying a specification. |
add_properties(self, specification, value) |
Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well. |
set_properties(self, specification, value) |
Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well. This method is a combination of MetadataPackage.add_properties and MetadataPackage.update_properties.
If an existing property satisfies the specification its value is updated. If there is a known property missing in the package that satisfies the specification it is added to the package. |
sanitize(self) |
Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well. |
set(self, field) |
Adds or replaces the specified Lyrics3 field. |
remove(self, id) |
Removes the field with the specified id. |
get(self, id) |
Gets the value of the field with the specified id. |
to_list(self) |
Creates a list from the package. |
Remarks
Lyrics3 v2.00 uses fields to represent information. The data in a field can consist of ASCII characters in the range 01 to 254 according to the standard. As the ASCII character map is only defined from 00 to 128 ISO-8859-1 might be assumed. Numerical fields are 5 or 6 characters long, depending on location, and are padded with zeroes.
Learn more | | |
Example
This code sample shows how to read the Lyrics tag from an MP3 file.
See Also
- module
groupdocs.metadata.formats.audio - class
CustomPackage - class
LyricsTag - class
MetadataPackage