![]() |
|
An implementation of ID3v2 comments. More...
#include <commentsframe.h>
Public Member Functions | |
CommentsFrame (String::Type encoding=String::Latin1) | |
CommentsFrame (const ByteVector &data) | |
virtual | ~CommentsFrame () |
virtual String | toString () const |
ByteVector | language () const |
String | description () const |
String | text () const |
void | setLanguage (const ByteVector &languageCode) |
void | setDescription (const String &s) |
virtual void | setText (const String &s) |
String::Type | textEncoding () const |
void | setTextEncoding (String::Type encoding) |
PropertyMap | asProperties () const |
![]() | |
virtual | ~Frame () |
ByteVector | frameID () const |
unsigned int | size () const |
void | setData (const ByteVector &data) |
ByteVector | render () const |
TAGLIB_DEPRECATED | Header (const ByteVector &data, bool synchSafeInts) |
Header (const ByteVector &data, unsigned int version=4) | |
virtual | ~Header () |
TAGLIB_DEPRECATED void | setData (const ByteVector &data, bool synchSafeInts) |
void | setData (const ByteVector &data, unsigned int version=4) |
ByteVector | frameID () const |
void | setFrameID (const ByteVector &id) |
unsigned int | frameSize () const |
void | setFrameSize (unsigned int size) |
unsigned int | version () const |
void | setVersion (unsigned int version) |
bool | tagAlterPreservation () const |
void | setTagAlterPreservation (bool discard) |
bool | fileAlterPreservation () const |
bool | readOnly () const |
bool | groupingIdentity () const |
bool | compression () const |
bool | encryption () const |
bool | unsynchronisation () const |
bool | dataLengthIndicator () const |
ByteVector | render () const |
TAGLIB_DEPRECATED bool | frameAlterPreservation () const |
Static Public Member Functions | |
static CommentsFrame * | findByDescription (const Tag *tag, const String &d) |
![]() | |
static Frame * | createTextualFrame (const String &key, const StringList &values) |
static unsigned int | headerSize () |
static unsigned int | headerSize (unsigned int version) |
static ByteVector | textDelimiter (String::Type t) |
static unsigned int | size () |
static unsigned int | size (unsigned int version) |
Protected Member Functions | |
virtual void | parseFields (const ByteVector &data) |
virtual ByteVector | renderFields () const |
![]() | |
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 *position=0) |
String::Type | checkTextEncoding (const StringList &fields, String::Type encoding) const |
PropertyMap | asProperties () 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, unsigned int 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 implementation of ID3v2 comments.
This implements the ID3v2 comment format. An ID3v2 comment consists of a language encoding, a description and a single text field.
|
explicit |
Construct an empty comment frame that will use the text encoding encoding.
|
explicit |
Construct a comment based on the data in data.
|
virtual |
Destroys this CommentFrame instance.
PropertyMap TagLib::ID3v2::CommentsFrame::asProperties | ( | ) | const |
Parses this frame as PropertyMap with a single key.
String TagLib::ID3v2::CommentsFrame::description | ( | ) | const |
Returns the description of this comment.
|
static |
Comments each have a unique description. This searches for a comment frame with the description d and returns a pointer to it. If no frame is found that matches the given description null is returned.
ByteVector TagLib::ID3v2::CommentsFrame::language | ( | ) | const |
Returns the language encoding as a 3 byte encoding as specified by ISO-639-2.
|
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::CommentsFrame::setDescription | ( | const String & | s | ) |
Sets the description of the comment to s.
void TagLib::ID3v2::CommentsFrame::setLanguage | ( | const ByteVector & | languageCode | ) |
Set the language using the 3 byte language code from ISO-639-2 to languageCode.
|
virtual |
void TagLib::ID3v2::CommentsFrame::setTextEncoding | ( | String::Type | encoding | ) |
Sets the text encoding to be used when rendering this frame to encoding.
String TagLib::ID3v2::CommentsFrame::text | ( | ) | const |
Returns the text of this comment.
String::Type TagLib::ID3v2::CommentsFrame::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 |
|
friend |