TagLib 1.6.1 (TagLib: TagLib::ID3v2::UnsynchronizedLyricsFrame Class Reference)

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:

List of all members.

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)

Protected Member Functions

virtual void parseFields (const ByteVector &data)
virtual ByteVector renderFields () const

Friends

class FrameFactory


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

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

Returns the description of this unsynchronized lyrics frame.

Note:
Most taggers simply ignore this value.
See also:
setDescription()

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  )  [protected, virtual]

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 [protected, virtual]

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]

Reimplemented from TagLib::ID3v2::Frame.


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