ID3V2TextFrame class

ID3V2TextFrame class

Represents a text frame in an ID3V2Tag. Almost all frames starting with the T character fall into this category. There is only one exception, which is the TXXX frame represented by the ID3V2UserDefinedFrame class.

Inheritance: ID3V2TextFrame → ID3V2TagFrame → CustomPackage → MetadataPackage

The ID3V2TextFrame type exposes the following members:

Constructors

Constructor Description
__init__(self, id, encoding, value) Initializes a new instance of the ID3V2TextFrame 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.
id Gets the id of the frame (four characters matching the pattern [A-Z0-9]).
flags Gets the frame flags.
data Gets the frame data.
text_encoding Gets the text encoding.
text Gets the text value.

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.

Remarks

Learn more | | |

See Also

ID3V2TagFrameFlags class ID3V2UrlLinkFrame class