An implementation of ID3v2 comments. More...

#include <commentsframe.h>

Inheritance diagram for TagLib::ID3v2::CommentsFrame:
Collaboration diagram for TagLib::ID3v2::CommentsFrame:

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
- Public Member Functions inherited from TagLib::ID3v2::Frame
virtual ~Frame ()
ByteVector frameID () const
unsigned int size () const
void setData (const ByteVector &data)
ByteVector render () const
 Header (const ByteVector &data, bool synchSafeInts)
 Header (const ByteVector &data, unsigned int version=4)
virtual ~Header ()
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
bool frameAlterPreservation () const

Static Public Member Functions

static CommentsFramefindByDescription (const Tag *tag, const String &d)
- Static Public Member Functions inherited from TagLib::ID3v2::Frame
static FramecreateTextualFrame (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
- Protected Member Functions inherited from TagLib::ID3v2::Frame
 Frame (const ByteVector &data)
 Frame (Header *h)
Headerheader () 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
PropertyMap asProperties () const


class FrameFactory

Additional Inherited Members

- Static Public Attributes inherited from TagLib::ID3v2::Frame
static const String instrumentPrefix
static const String commentPrefix
static const String lyricsPrefix
static const String urlPrefix
- Static Protected Member Functions inherited from TagLib::ID3v2::Frame
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)

Detailed Description

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.

Constructor & Destructor Documentation

TagLib::ID3v2::CommentsFrame::CommentsFrame ( String::Type  encoding = String::Latin1)

Construct an empty comment frame that will use the text encoding encoding.

TagLib::ID3v2::CommentsFrame::CommentsFrame ( const ByteVector data)

Construct a comment based on the data in data.

virtual TagLib::ID3v2::CommentsFrame::~CommentsFrame ( )

Destroys this CommentFrame instance.

Member Function Documentation

PropertyMap TagLib::ID3v2::CommentsFrame::asProperties ( ) const

Parses this frame as PropertyMap with a single key.

  • if description() is empty or "COMMENT", the key will be "COMMENT"
  • if description() is not a valid PropertyMap key, the frame will be marked unsupported by an entry "COMM/<description>" in the unsupportedData() attribute of the returned map.
  • otherwise, the key will be "COMMENT:<description>"
  • The single value will be the frame's text().
String TagLib::ID3v2::CommentsFrame::description ( ) const

Returns the description of this comment.

Most taggers simply ignore this value.
See also
static CommentsFrame* TagLib::ID3v2::CommentsFrame::findByDescription ( const Tag tag,
const String d 

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.

See also
ByteVector TagLib::ID3v2::CommentsFrame::language ( ) const

Returns the language encoding as a 3 byte encoding as specified by ISO-639-2.

Most taggers simply ignore this value.
See also
virtual void TagLib::ID3v2::CommentsFrame::parseFields ( const ByteVector data)

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::CommentsFrame::renderFields ( ) const

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.

See also
void TagLib::ID3v2::CommentsFrame::setLanguage ( const ByteVector languageCode)

Set the language using the 3 byte language code from ISO-639-2 to languageCode.

See also
virtual void TagLib::ID3v2::CommentsFrame::setText ( const String s)

Sets the text portion of the comment to s.

See also

Reimplemented from TagLib::ID3v2::Frame.

void TagLib::ID3v2::CommentsFrame::setTextEncoding ( String::Type  encoding)

Sets the text encoding to be used when rendering this frame to encoding.

See also
String TagLib::ID3v2::CommentsFrame::text ( ) const

Returns the text of this comment.

See also
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.

See also
virtual String TagLib::ID3v2::CommentsFrame::toString ( ) const

Returns the text of this comment.

See also

Implements TagLib::ID3v2::Frame.

Friends And Related Function Documentation

friend class FrameFactory

The documentation for this class was generated from the following file: