TagLib
1.13.1
|
ID3v2 synchronized lyrics frame. More...
#include <synchronizedlyricsframe.h>
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< SynchedText > | SynchedTextList |
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) |
![]() | |
virtual | ~Frame () |
ByteVector | frameID () const |
unsigned int | size () const |
void | setData (const ByteVector &data) |
virtual void | setText (const String &text) |
ByteVector | render () const |
Protected Member Functions | |
virtual void | parseFields (const ByteVector &data) |
virtual ByteVector | renderFields () const |
![]() | |
Frame (const ByteVector &data) | |
Frame (Header *h) | |
Header * | header () 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 *position=0) |
String::Type | checkTextEncoding (const StringList &fields, String::Type encoding) const |
PropertyMap | asProperties () const |
Friends | |
class | FrameFactory |
Additional Inherited Members | |
![]() | |
static Frame * | createTextualFrame (const String &key, const StringList &values) |
static unsigned int | headerSize () |
static unsigned int | headerSize (unsigned int version) |
static ByteVector | textDelimiter (String::Type t) |
![]() | |
static const String | instrumentPrefix |
static const String | commentPrefix |
static const String | lyricsPrefix |
static const String | urlPrefix |
![]() | |
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) |
List of synchronized lyrics.
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.
|
explicit |
Construct an empty synchronized lyrics frame that will use the text encoding encoding.
References TagLib::String::Latin1.
Referenced by renderFields().
|
explicit |
Construct a synchronized lyrics frame based on the data in data.
|
virtual |
Destroys this SynchronizedLyricsFrame instance.
String TagLib::ID3v2::SynchronizedLyricsFrame::description | ( | ) | const |
Returns the description of this synchronized lyrics frame.
ByteVector TagLib::ID3v2::SynchronizedLyricsFrame::language | ( | ) | const |
Returns the language encoding as a 3 byte encoding as specified by ISO-639-2.
|
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.
|
protectedvirtual |
Render the field data back to a binary format in a ByteVector. This must be overridden by subclasses.
Implements TagLib::ID3v2::Frame.
References SynchronizedLyricsFrame().
void TagLib::ID3v2::SynchronizedLyricsFrame::setDescription | ( | const String & | s | ) |
Sets the description of the synchronized lyrics frame to s.
void TagLib::ID3v2::SynchronizedLyricsFrame::setLanguage | ( | const ByteVector & | languageCode | ) |
Set the language using the 3 byte language code from ISO-639-2 to languageCode.
void TagLib::ID3v2::SynchronizedLyricsFrame::setSynchedText | ( | const SynchedTextList & | t | ) |
Sets the text with the time stamps.
void TagLib::ID3v2::SynchronizedLyricsFrame::setTextEncoding | ( | String::Type | encoding | ) |
Sets the text encoding to be used when rendering this frame to encoding.
void TagLib::ID3v2::SynchronizedLyricsFrame::setTimestampFormat | ( | TimestampFormat | f | ) |
Set the timestamp format.
void TagLib::ID3v2::SynchronizedLyricsFrame::setType | ( | Type | t | ) |
Set the type of text contained.
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.
TimestampFormat TagLib::ID3v2::SynchronizedLyricsFrame::timestampFormat | ( | ) | const |
Returns the timestamp format.
|
virtual |
Returns the description of this synchronized lyrics frame.
Implements TagLib::ID3v2::Frame.
Type TagLib::ID3v2::SynchronizedLyricsFrame::type | ( | ) | const |
Returns the type of text contained.
|
friend |
References FrameFactory.
Referenced by FrameFactory.