TagLib 1.11 (TagLib: TagLib::ID3v2::SynchronizedLyricsFrame Class Reference)

TagLib::ID3v2::SynchronizedLyricsFrame Class Reference

ID3v2 synchronized lyrics frame. More...

#include <synchronizedlyricsframe.h>

Inheritance diagram for TagLib::ID3v2::SynchronizedLyricsFrame:
Collaboration diagram for TagLib::ID3v2::SynchronizedLyricsFrame:

List of all members.

Classes

struct  SynchedText

Public Types

enum  TimestampFormat { Unknown = 0x00, AbsoluteMpegFrames = 0x01, AbsoluteMilliseconds = 0x02 }
enum  Type {
  Other = 0x00, Lyrics = 0x01, TextTranscription = 0x02, Movement = 0x03,
  Events = 0x04, Chord = 0x05, Trivia = 0x06, WebpageUrls = 0x07,
  ImageUrls = 0x08
}
typedef TagLib::List< SynchedTextSynchedTextList

Public Member Functions

 SynchronizedLyricsFrame (String::Type encoding=String::Latin1)
 SynchronizedLyricsFrame (const ByteVector &data)
virtual ~SynchronizedLyricsFrame ()
virtual String toString () const
String::Type textEncoding () const
ByteVector language () const
TimestampFormat timestampFormat () const
Type type () const
String description () const
SynchedTextList synchedText () const
void setTextEncoding (String::Type encoding)
void setLanguage (const ByteVector &languageCode)
void setTimestampFormat (TimestampFormat f)
void setType (Type t)
void setDescription (const String &s)
void setSynchedText (const SynchedTextList &t)

Protected Member Functions

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

Friends

class FrameFactory

Detailed Description

ID3v2 synchronized lyrics frame.

An implementation of ID3v2 synchronized lyrics.


Member Typedef Documentation


Member Enumeration Documentation

Specifies the timestamp format used.

Enumerator:
Unknown 

The timestamp is of unknown format.

AbsoluteMpegFrames 

The timestamp represents the number of MPEG frames since the beginning of the audio stream.

AbsoluteMilliseconds 

The timestamp represents the number of milliseconds since the beginning of the audio stream.

Specifies the type of text contained.

Enumerator:
Other 

The text is some other type of text.

Lyrics 

The text contains lyrical data.

TextTranscription 

The text contains a transcription.

Movement 

The text lists the movements in the piece.

Events 

The text describes events that occur.

Chord 

The text contains chord changes that occur in the music.

Trivia 

The text contains trivia or "pop up" information about the media.

WebpageUrls 

The text contains URLs for relevant webpages.

ImageUrls 

The text contains URLs for relevant images.


Constructor & Destructor Documentation

TagLib::ID3v2::SynchronizedLyricsFrame::SynchronizedLyricsFrame ( String::Type  encoding = String::Latin1) [explicit]

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

TagLib::ID3v2::SynchronizedLyricsFrame::SynchronizedLyricsFrame ( const ByteVector data) [explicit]

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

virtual TagLib::ID3v2::SynchronizedLyricsFrame::~SynchronizedLyricsFrame ( ) [virtual]

Destroys this SynchronizedLyricsFrame instance.


Member Function Documentation

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

Returns the description of this synchronized lyrics frame.

Note:
Most taggers simply ignore this value.
See also:
setDescription()
ByteVector TagLib::ID3v2::SynchronizedLyricsFrame::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::SynchronizedLyricsFrame::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::SynchronizedLyricsFrame::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::SynchronizedLyricsFrame::setDescription ( const String s)

Sets the description of the synchronized lyrics frame to s.

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

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

See also:
language()
void TagLib::ID3v2::SynchronizedLyricsFrame::setSynchedText ( const SynchedTextList t)

Sets the text with the time stamps.

See also:
text()
void TagLib::ID3v2::SynchronizedLyricsFrame::setTextEncoding ( String::Type  encoding)

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

See also:
textEncoding()
render()
void TagLib::ID3v2::SynchronizedLyricsFrame::setTimestampFormat ( TimestampFormat  f)

Set the timestamp format.

See also:
timestampFormat()
void TagLib::ID3v2::SynchronizedLyricsFrame::setType ( Type  t)

Set the type of text contained.

See also:
type()
SynchedTextList TagLib::ID3v2::SynchronizedLyricsFrame::synchedText ( ) const

Returns the text with the time stamps.

String::Type TagLib::ID3v2::SynchronizedLyricsFrame::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()
TimestampFormat TagLib::ID3v2::SynchronizedLyricsFrame::timestampFormat ( ) const

Returns the timestamp format.

virtual String TagLib::ID3v2::SynchronizedLyricsFrame::toString ( ) const [virtual]

Returns the description of this synchronized lyrics frame.

See also:
description()

Implements TagLib::ID3v2::Frame.

Type TagLib::ID3v2::SynchronizedLyricsFrame::type ( ) const

Returns the type of text contained.


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: