![]() |
|
An ID3v2 text identification frame implementation. More...
#include <textidentificationframe.h>
Static Public Member Functions | |
static TextIdentificationFrame * | createTIPLFrame (const PropertyMap &properties) |
static TextIdentificationFrame * | createTMCLFrame (const PropertyMap &properties) |
static const KeyConversionMap & | involvedPeopleMap () |
![]() | |
static Frame * | createTextualFrame (const String &key, const StringList &values) |
static uint | headerSize () |
static uint | headerSize (uint version) |
static ByteVector | textDelimiter (String::Type t) |
static uint | size () |
static uint | size (uint version) |
Protected Member Functions | |
virtual void | parseFields (const ByteVector &data) |
virtual ByteVector | renderFields () const |
TextIdentificationFrame (const ByteVector &data, Header *h) | |
![]() | |
Frame (const ByteVector &data) | |
Frame (Header *h) | |
Header * | header () const |
void | setHeader (Header *h, bool deleteCurrent=true) |
void | parse (const ByteVector &data) |
ByteVector | fieldData (const ByteVector &frameData) const |
String | readStringField (const ByteVector &data, String::Type encoding, int *positon=0) |
String::Type | checkTextEncoding (const StringList &fields, String::Type encoding) const |
Friends | |
class | FrameFactory |
Additional Inherited Members | |
![]() | |
static const String | instrumentPrefix |
static const String | commentPrefix |
static const String | lyricsPrefix |
static const String | urlPrefix |
![]() | |
static String::Type | checkEncoding (const StringList &fields, String::Type encoding) |
static String::Type | checkEncoding (const StringList &fields, String::Type encoding, uint version) |
static ByteVector | keyToFrameID (const String &) |
static String | frameIDToKey (const ByteVector &) |
static String | keyToTXXX (const String &) |
static String | txxxToKey (const String &) |
static void | splitProperties (const PropertyMap &original, PropertyMap &singleFrameProperties, PropertyMap &tiplProperties, PropertyMap &tmclProperties) |
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:
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.
|
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 |
Destroys this TextIdentificationFrame instance.
|
protected |
The constructor used by the FrameFactory.
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.
|
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 |
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.
StringList TagLib::ID3v2::TextIdentificationFrame::fieldList | ( | ) | const |
Returns a list of the strings in this frame.
Reimplemented in TagLib::ID3v2::UserTextIdentificationFrame.
|
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.
|
protectedvirtual |
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.
|
protectedvirtual |
Render the field data back to a binary format in a ByteVector. This must be overridden by subclasses.
Implements TagLib::ID3v2::Frame.
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 |
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::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 |
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 |
Reimplemented from TagLib::ID3v2::Frame.
Reimplemented in TagLib::ID3v2::UserTextIdentificationFrame.