![]() |
|
#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 |
PropertyMap | asProperties () const |
Static Public Member Functions | |
static TextIdentificationFrame * | createTIPLFrame (const PropertyMap &properties) |
static TextIdentificationFrame * | createTMCLFrame (const PropertyMap &properties) |
static const KeyConversionMap & | involvedPeopleMap () |
Protected Member Functions | |
virtual void | parseFields (const ByteVector &data) |
virtual ByteVector | renderFields () const |
TextIdentificationFrame (const ByteVector &data, Header *h) | |
Friends | |
class | FrameFactory |
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:
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.
Please see the note in the class description regarding Latin1.
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.
static TextIdentificationFrame* TagLib::ID3v2::TextIdentificationFrame::createTIPLFrame | ( | const PropertyMap & | properties | ) | [static] |
This is a special factory method to create a TIPL (involved people list) frame from the given properties. Will parse key=[list of values] data into the TIPL format as specified in the ID3 standard.
static TextIdentificationFrame* TagLib::ID3v2::TextIdentificationFrame::createTMCLFrame | ( | const PropertyMap & | properties | ) | [static] |
This is a special factory method to create a TMCL (musician credits list) frame from the given properties. Will parse key=[list of values] data into the TMCL format as specified in the ID3 standard, where key should be of the form instrumentPrefix:instrument.
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.
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.
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.
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.
void TagLib::ID3v2::TextIdentificationFrame::setTextEncoding | ( | String::Type | encoding | ) |
Sets the text encoding to be used when rendering this frame to encoding.
StringList TagLib::ID3v2::TextIdentificationFrame::fieldList | ( | ) | const |
Returns a list of the strings in this frame.
Reimplemented in TagLib::ID3v2::UserTextIdentificationFrame.
static const KeyConversionMap& TagLib::ID3v2::TextIdentificationFrame::involvedPeopleMap | ( | ) | [static] |
Returns a KeyConversionMap mapping a role as it would be used in a PropertyMap to the corresponding key used in a TIPL ID3 frame to describe that role.
PropertyMap TagLib::ID3v2::TextIdentificationFrame::asProperties | ( | ) | const |
Parses the contents of this frame as PropertyMap. If that fails, the returend PropertyMap will be empty, and its unsupportedData() will contain this frame's ID. BIC: Will be a virtual function in future releases.
Reimplemented from TagLib::ID3v2::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.
friend class FrameFactory [friend] |
Reimplemented from TagLib::ID3v2::Frame.
Reimplemented in TagLib::ID3v2::UserTextIdentificationFrame.