TagLib::ID3v2::UserTextIdentificationFrame Class Reference

An ID3v2 custom text identification frame implementation. More...

#include <textidentificationframe.h>

Inheritance diagram for TagLib::ID3v2::UserTextIdentificationFrame:
Collaboration diagram for TagLib::ID3v2::UserTextIdentificationFrame:

Public Member Functions

 UserTextIdentificationFrame (String::Type encoding=String::Latin1)
 UserTextIdentificationFrame (const ByteVector &data)
 UserTextIdentificationFrame (const String &description, const StringList &values, String::Type encoding=String::UTF8)
virtual String toString () const
String description () const
void setDescription (const String &s)
StringList fieldList () const
void setText (const String &text)
void setText (const StringList &fields)
PropertyMap asProperties () const
- Public Member Functions inherited from TagLib::ID3v2::TextIdentificationFrame
 TextIdentificationFrame (const ByteVector &type, String::Type encoding)
 TextIdentificationFrame (const ByteVector &data)
virtual ~TextIdentificationFrame ()
void setText (const StringList &l)
String::Type textEncoding () const
void setTextEncoding (String::Type encoding)
StringList fieldList () const
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 UserTextIdentificationFramefind (Tag *tag, const String &description)
- Static Public Member Functions inherited from TagLib::ID3v2::TextIdentificationFrame
static TextIdentificationFramecreateTIPLFrame (const PropertyMap &properties)
static TextIdentificationFramecreateTMCLFrame (const PropertyMap &properties)
static const KeyConversionMapinvolvedPeopleMap ()
- 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)


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
- Protected Member Functions inherited from TagLib::ID3v2::TextIdentificationFrame
virtual void parseFields (const ByteVector &data)
virtual ByteVector renderFields () const
 TextIdentificationFrame (const ByteVector &data, Header *h)
- 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
- 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 ID3v2 custom text identification frame implementation.

This is a specialization of text identification frames that allows for user defined entries. Each entry has a description in addition to the normal list of fields that a text identification frame has.

This description identifies the frame and must be unique.

Constructor & Destructor Documentation

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

Constructs an empty user defined text identification frame. For this to be a useful frame both a description and text must be set.

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

Creates a frame based on data.

TagLib::ID3v2::UserTextIdentificationFrame::UserTextIdentificationFrame ( const String description,
const StringList values,
String::Type  encoding = String::UTF8 

Creates a user defined text identification frame with the given description and values.

Member Function Documentation

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

A UserTextIdentificationFrame is parsed into a PropertyMap as follows:

  • the key is the frame's description, uppercased
  • if the description contains '::', only the substring after that separator is considered as key (compatibility with exfalso)
  • if the above rules don't yield a valid key (e.g. containing non-ASCII characters), the returned map will contain an entry "TXXX/<description>" in its unsupportedData() list.
  • The values will be copies of the fieldList().
  • If the description() appears as value in fieldList(), it will be omitted in the value list, in order to be compatible with TagLib which copies the description() into the fieldList().
String TagLib::ID3v2::UserTextIdentificationFrame::description ( ) const

Returns the description for this frame.

StringList TagLib::ID3v2::UserTextIdentificationFrame::fieldList ( ) const
static UserTextIdentificationFrame* TagLib::ID3v2::UserTextIdentificationFrame::find ( Tag tag,
const String description 

Searches for the user defined text frame with the description description in tag. This returns null if no matching frames were found.

void TagLib::ID3v2::UserTextIdentificationFrame::setDescription ( const String s)

Sets the description of the frame to s. s must be unique. You can check for the presence of another user defined text frame of the same type using find() and testing for null.

void TagLib::ID3v2::UserTextIdentificationFrame::setText ( const String text)

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.

If the frame type supports multiple text encodings, this will not change the text encoding of the frame; the string will be converted to that frame's encoding. Please use the specific APIs of the frame types to set the encoding if that is desired.

Reimplemented from TagLib::ID3v2::TextIdentificationFrame.

void TagLib::ID3v2::UserTextIdentificationFrame::setText ( const StringList fields)
virtual String TagLib::ID3v2::UserTextIdentificationFrame::toString ( ) const

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.

Reimplemented from TagLib::ID3v2::TextIdentificationFrame.

Friends And Related Function Documentation

friend class FrameFactory

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