![]() |
|
An ID3v2 text identification frame implementation. More...
#include <textidentificationframe.h>
Public Member Functions | |
TextIdentificationFrame (const ByteVector &type, String::Type encoding) | |
TextIdentificationFrame (const ByteVector &data) | |
virtual | ~TextIdentificationFrame () |
void | setText (const StringList &l) |
virtual void | setText (const String &s) |
virtual String | toString () const |
String::Type | textEncoding () const |
void | setTextEncoding (String::Type encoding) |
StringList | fieldList () const |
Protected Member Functions | |
virtual void | parseFields (const ByteVector &data) |
virtual ByteVector | renderFields () const |
TextIdentificationFrame (const ByteVector &data, Header *h) | |
Friends | |
class | FrameFactory |
An ID3v2 text identification frame implementation.
This is an implementation of the most common type of ID3v2 frame -- text identification frames. There are a number of variations on this. Those enumerated in the ID3v2.4 standard are:
TALB Album/Movie/Show title TBPM BPM (beats per minute) TCOM Composer TCON Content type TCOP Copyright message TDEN Encoding time TDLY Playlist delay TDOR Original release time TDRC Recording time TDRL Release time TDTG Tagging time TENC Encoded by TEXT Lyricist/Text writer TFLT File type TIPL Involved people list TIT1 Content group description TIT2 Title/songname/content description TIT3 Subtitle/Description refinement TKEY Initial key TLAN Language(s) TLEN Length TMCL Musician credits list TMED Media type TMOO Mood TOAL Original album/movie/show title TOFN Original filename TOLY Original lyricist(s)/text writer(s) TOPE Original artist(s)/performer(s) TOWN File owner/licensee TPE1 Lead performer(s)/Soloist(s) TPE2 Band/orchestra/accompaniment TPE3 Conductor/performer refinement TPE4 Interpreted, remixed, or otherwise modified by TPOS Part of a set TPRO Produced notice TPUB Publisher TRCK Track number/Position in set TRSN Internet radio station name TRSO Internet radio station owner TSOA Album sort order TSOP Performer sort order TSOT Title sort order TSRC ISRC (international standard recording code) TSSE Software/Hardware and settings used for encoding TSST Set subtitle
The ID3v2 Frames document gives a description of each of these formats and the expected order of strings in each. ID3v2::Header::frameID() can be used to determine the frame type.
TagLib::ID3v2::TextIdentificationFrame::TextIdentificationFrame | ( | const ByteVector & | type, | |
String::Type | encoding | |||
) |
Construct an empty frame of type type. Uses encoding as the default text encoding.
TagLib::ID3v2::TextIdentificationFrame::TextIdentificationFrame | ( | const ByteVector & | data | ) | [explicit] |
This is a dual purpose constructor. data can either be binary data that should be parsed or (at a minimum) the frame ID.
virtual TagLib::ID3v2::TextIdentificationFrame::~TextIdentificationFrame | ( | ) | [virtual] |
Destroys this TextIdentificationFrame instance.
TagLib::ID3v2::TextIdentificationFrame::TextIdentificationFrame | ( | const ByteVector & | data, | |
Header * | h | |||
) | [protected] |
The constructor used by the FrameFactory.
StringList TagLib::ID3v2::TextIdentificationFrame::fieldList | ( | ) | const |
Returns a list of the strings in this frame.
Reimplemented in TagLib::ID3v2::UserTextIdentificationFrame.
virtual void TagLib::ID3v2::TextIdentificationFrame::parseFields | ( | const ByteVector & | data | ) | [protected, virtual] |
Called by parse() to parse the field data. It makes this information available through the public API. This must be overridden by the subclasses.
Implements TagLib::ID3v2::Frame.
virtual ByteVector TagLib::ID3v2::TextIdentificationFrame::renderFields | ( | ) | const [protected, virtual] |
Render the field data back to a binary format in a ByteVector. This must be overridden by subclasses.
Implements TagLib::ID3v2::Frame.
virtual void TagLib::ID3v2::TextIdentificationFrame::setText | ( | const String & | text | ) | [virtual] |
Set the text of frame in the sanest way possible. This should only be reimplemented in frames where there is some logical mapping to text.
Reimplemented from TagLib::ID3v2::Frame.
Reimplemented in TagLib::ID3v2::UserTextIdentificationFrame.
void TagLib::ID3v2::TextIdentificationFrame::setText | ( | const StringList & | l | ) |
Text identification frames are a list of string fields.
This function will accept either a StringList or a String (using the StringList constructor that accepts a single String).
Reimplemented in TagLib::ID3v2::UserTextIdentificationFrame.
void TagLib::ID3v2::TextIdentificationFrame::setTextEncoding | ( | String::Type | encoding | ) |
Sets the text encoding to be used when rendering this frame to encoding.
String::Type TagLib::ID3v2::TextIdentificationFrame::textEncoding | ( | ) | const |
Returns the text encoding that will be used in rendering this frame. This defaults to the type that was either specified in the constructor or read from the frame when parsed.
virtual String TagLib::ID3v2::TextIdentificationFrame::toString | ( | ) | const [virtual] |
This returns the textual representation of the data in the frame. Subclasses must reimplement this method to provide a string representation of the frame's data.
Implements TagLib::ID3v2::Frame.
Reimplemented in TagLib::ID3v2::UserTextIdentificationFrame.
friend class FrameFactory [friend] |
Reimplemented from TagLib::ID3v2::Frame.
Reimplemented in TagLib::ID3v2::UserTextIdentificationFrame.