TagLib::ID3v2::UnsynchronizedLyricsFrame Class Reference

ID3v2 unsynchronized lyrics frame. More...

#include <unsynchronizedlyricsframe.h>

Inheritance diagram for TagLib::ID3v2::UnsynchronizedLyricsFrame:
Collaboration diagram for TagLib::ID3v2::UnsynchronizedLyricsFrame:

Public Member Functions

 UnsynchronizedLyricsFrame (String::Type encoding=String::Latin1)
 UnsynchronizedLyricsFrame (const ByteVector &data)
virtual ~UnsynchronizedLyricsFrame ()
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
uint size () const
void setData (const ByteVector &data)
ByteVector render () const
 Header (const ByteVector &data, bool synchSafeInts)
 Header (const ByteVector &data, uint version=4)
virtual ~Header ()
void setData (const ByteVector &data, bool synchSafeInts)
void setData (const ByteVector &data, uint version=4)
ByteVector frameID () const
void setFrameID (const ByteVector &id)
uint frameSize () const
void setFrameSize (uint size)
uint version () const
void setVersion (uint 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 UnsynchronizedLyricsFramefindByDescription (const Tag *tag, const String &d)
- Static Public Member Functions inherited from TagLib::ID3v2::Frame
static FramecreateTextualFrame (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
- 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

Friends

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, 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)

Detailed Description

ID3v2 unsynchronized lyrics frame.

An implementation of ID3v2 unsynchronized lyrics.

Constructor & Destructor Documentation

TagLib::ID3v2::UnsynchronizedLyricsFrame::UnsynchronizedLyricsFrame ( String::Type  encoding = String::Latin1)
explicit

Construct an empty unsynchronized lyrics frame that will use the text encoding encoding.

TagLib::ID3v2::UnsynchronizedLyricsFrame::UnsynchronizedLyricsFrame ( const ByteVector data)
explicit

Construct a unsynchronized lyrics frame based on the data in data.

virtual TagLib::ID3v2::UnsynchronizedLyricsFrame::~UnsynchronizedLyricsFrame ( )
virtual

Destroys this UnsynchronizedLyricsFrame instance.

Member Function Documentation

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

Parses this frame as PropertyMap with a single key.

  • if description() is empty or "LYRICS", the key will be "LYRICS"
  • if description() is not a valid PropertyMap key, the frame will be marked unsupported by an entry "USLT/<description>" in the unsupportedData() attribute of the returned map.
  • otherwise, the key will be "LYRICS:<description>"
  • The single value will be the frame's text(). Note that currently the language() field is not supported by the PropertyMap interface.

Reimplemented from TagLib::ID3v2::Frame.

String TagLib::ID3v2::UnsynchronizedLyricsFrame::description ( ) const

Returns the description of this unsynchronized lyrics frame.

Note
Most taggers simply ignore this value.
See Also
setDescription()
static UnsynchronizedLyricsFrame* TagLib::ID3v2::UnsynchronizedLyricsFrame::findByDescription ( const Tag tag,
const String d 
)
static

LyricsFrames each have a unique description. This searches for a lyrics frame with the decription d and returns a pointer to it. If no frame is found that matches the given description null is returned.

See Also
description()
ByteVector TagLib::ID3v2::UnsynchronizedLyricsFrame::language ( ) const

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

Note
Most taggers simply ignore this value.
See Also
setLanguage()
virtual void TagLib::ID3v2::UnsynchronizedLyricsFrame::parseFields ( const ByteVector data)
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.

virtual ByteVector TagLib::ID3v2::UnsynchronizedLyricsFrame::renderFields ( ) const
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::UnsynchronizedLyricsFrame::setDescription ( const String s)

Sets the description of the unsynchronized lyrics frame to s.

See Also
decription()
void TagLib::ID3v2::UnsynchronizedLyricsFrame::setLanguage ( const ByteVector languageCode)

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

See Also
language()
virtual void TagLib::ID3v2::UnsynchronizedLyricsFrame::setText ( const String s)
virtual

Sets the text portion of the unsynchronized lyrics frame to s.

See Also
text()

Reimplemented from TagLib::ID3v2::Frame.

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

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

See Also
textEncoding()
render()
String TagLib::ID3v2::UnsynchronizedLyricsFrame::text ( ) const

Returns the text of this unsynchronized lyrics frame.

See Also
setText()
String::Type TagLib::ID3v2::UnsynchronizedLyricsFrame::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
setTextEncoding()
render()
virtual String TagLib::ID3v2::UnsynchronizedLyricsFrame::toString ( ) const
virtual

Returns the text of this unsynchronized lyrics frame.

See Also
text()

Implements TagLib::ID3v2::Frame.

Friends And Related Function Documentation

friend class FrameFactory
friend

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