Miam-Player  0.8.0
A nice music player
TagLib::ID3v2::SynchronizedLyricsFrame Class Reference

ID3v2 synchronized lyrics frame. More...

#include <synchronizedlyricsframe.h>

Inheritance diagram for TagLib::ID3v2::SynchronizedLyricsFrame:
TagLib::ID3v2::Frame TagLib::ID3v2::Header

Classes

struct  SynchedText
 Single entry of time stamp and lyrics text. More...
 

Public Types

enum  TimestampFormat { Unknown = 0x00, AbsoluteMpegFrames = 0x01, AbsoluteMilliseconds = 0x02 }
 Specifies the timestamp format used. More...
 
enum  Type {
  Other = 0x00, Lyrics = 0x01, TextTranscription = 0x02, Movement = 0x03,
  Events = 0x04, Chord = 0x05, Trivia = 0x06, WebpageUrls = 0x07,
  ImageUrls = 0x08
}
 Specifies the type of text contained. More...
 
typedef TagLib::List< SynchedTextSynchedTextList
 List of synchronized lyrics. More...
 

Public Member Functions

 SynchronizedLyricsFrame (String::Type encoding=String::Latin1)
 Construct an empty synchronized lyrics frame that will use the text encoding encoding. More...
 
 SynchronizedLyricsFrame (const ByteVector &data)
 Construct a synchronized lyrics frame based on the data in data. More...
 
virtual ~SynchronizedLyricsFrame ()
 Destroys this SynchronizedLyricsFrame instance. More...
 
virtual String toString () const
 Returns the description of this synchronized lyrics frame. More...
 
String::Type textEncoding () const
 Returns the text encoding that will be used in rendering this frame. More...
 
ByteVector language () const
 Returns the language encoding as a 3 byte encoding as specified by ISO-639-2. More...
 
TimestampFormat timestampFormat () const
 Returns the timestamp format. More...
 
Type type () const
 Returns the type of text contained. More...
 
String description () const
 Returns the description of this synchronized lyrics frame. More...
 
SynchedTextList synchedText () const
 Returns the text with the time stamps. More...
 
void setTextEncoding (String::Type encoding)
 Sets the text encoding to be used when rendering this frame to encoding. More...
 
void setLanguage (const ByteVector &languageCode)
 Set the language using the 3 byte language code from ISO-639-2 to languageCode. More...
 
void setTimestampFormat (TimestampFormat f)
 Set the timestamp format. More...
 
void setType (Type t)
 Set the type of text contained. More...
 
void setDescription (const String &s)
 Sets the description of the synchronized lyrics frame to s. More...
 
void setSynchedText (const SynchedTextList &t)
 Sets the text with the time stamps. More...
 
- Public Member Functions inherited from TagLib::ID3v2::Frame
virtual ~Frame ()
 Destroys this Frame instance. More...
 
ByteVector frameID () const
 Returns the Frame ID (Structure, 4) (Frames, 4) More...
 
unsigned int size () const
 Returns the size of the frame. More...
 
void setData (const ByteVector &data)
 Sets the data that will be used as the frame. More...
 
virtual void setText (const String &text)
 Set the text of frame in the sanest way possible. More...
 
ByteVector render () const
 Render the frame back to its binary format in a ByteVector. More...
 
 Header (const ByteVector &data, bool synchSafeInts)
 Construct a Frame Header based on data. More...
 
 Header (const ByteVector &data, unsigned int version=4)
 Construct a Frame Header based on data. More...
 
virtual ~Header ()
 Destroys this Header instance. More...
 
void setData (const ByteVector &data, bool synchSafeInts)
 Sets the data for the Header. More...
 
void setData (const ByteVector &data, unsigned int version=4)
 Sets the data for the Header. More...
 
ByteVector frameID () const
 Returns the Frame ID (Structure, 4) (Frames, 4) More...
 
void setFrameID (const ByteVector &id)
 Sets the frame's ID to id. More...
 
unsigned int frameSize () const
 Returns the size of the frame data portion, as set when setData() was called or set explicitly via setFrameSize(). More...
 
void setFrameSize (unsigned int size)
 Sets the size of the frame data portion. More...
 
unsigned int version () const
 Returns the ID3v2 version of the header, as passed in from the construction of the header or set via setVersion(). More...
 
void setVersion (unsigned int version)
 Sets the ID3v2 version of the header, changing has impact on the correct parsing/rendering of frame data. More...
 
bool tagAlterPreservation () const
 Returns true if the flag for tag alter preservation is set. More...
 
void setTagAlterPreservation (bool discard)
 Sets the flag for preservation of this frame if the tag is set. More...
 
bool fileAlterPreservation () const
 Returns true if the flag for file alter preservation is set. More...
 
bool readOnly () const
 Returns true if the frame is meant to be read only. More...
 
bool groupingIdentity () const
 Returns true if the flag for the grouping identity is set. More...
 
bool compression () const
 Returns true if compression is enabled for this frame. More...
 
bool encryption () const
 Returns true if encryption is enabled for this frame. More...
 
bool unsycronisation () const
 
bool unsynchronisation () const
 Returns true if unsynchronisation is enabled for this frame. More...
 
bool dataLengthIndicator () const
 Returns true if the flag for a data length indicator is set. More...
 
ByteVector render () const
 Render the Header back to binary format in a ByteVector. More...
 
bool frameAlterPreservation () const
 

Protected Member Functions

virtual void parseFields (const ByteVector &data)
 Called by parse() to parse the field data. More...
 
virtual ByteVector renderFields () const
 Render the field data back to a binary format in a ByteVector. More...
 
- Protected Member Functions inherited from TagLib::ID3v2::Frame
 Frame (const ByteVector &data)
 Constructs an ID3v2 frame using data to read the header information. More...
 
 Frame (Header *h)
 This creates an Frame using the header h. More...
 
Headerheader () const
 Returns a pointer to the frame header. More...
 
void setHeader (Header *h, bool deleteCurrent=true)
 Sets the header to h. More...
 
void parse (const ByteVector &data)
 Called by setData() to parse the frame data. More...
 
ByteVector fieldData (const ByteVector &frameData) const
 Returns a ByteVector containing the field data given the frame data. More...
 
String readStringField (const ByteVector &data, String::Type encoding, int *positon=0)
 Reads a String of type encoding from the ByteVector data. More...
 
String::Type checkTextEncoding (const StringList &fields, String::Type encoding) const
 Checks a the list of string values to see if they can be used with the specified encoding and returns the recommended encoding. More...
 
PropertyMap asProperties () const
 Parses the contents of this frame as PropertyMap. More...
 

Friends

class FrameFactory
 

Additional Inherited Members

- Static Public Member Functions inherited from TagLib::ID3v2::Frame
static FramecreateTextualFrame (const String &key, const StringList &values)
 Creates a textual frame which corresponds to a single key in the PropertyMap interface. More...
 
static unsigned int headerSize ()
 Returns the size of the frame header. More...
 
static unsigned int headerSize (unsigned int version)
 Returns the size of the frame header for the given ID3v2 version. More...
 
static ByteVector textDelimiter (String::Type t)
 Returns the text delimiter that is used between fields for the string type t. More...
 
static unsigned int size ()
 Returns the size of the frame header in bytes. More...
 
static unsigned int size (unsigned int version)
 Returns the size of the frame header in bytes for the ID3v2 version that's given. More...
 
- Static Public Attributes inherited from TagLib::ID3v2::Frame
static const String instrumentPrefix
 The string with which an instrument name is prefixed to build a key in a PropertyMap; used to translate PropertyMaps to TMCL frames. More...
 
static const String commentPrefix
 The PropertyMap key prefix which triggers the use of a COMM frame instead of a TXXX frame for a non-standard key. More...
 
static const String lyricsPrefix
 The PropertyMap key prefix which triggers the use of a USLT frame instead of a TXXX frame for a non-standard key. More...
 
static const String urlPrefix
 The PropertyMap key prefix which triggers the use of a WXXX frame instead of a TXX frame for a non-standard key. More...
 
- Static Protected Member Functions inherited from TagLib::ID3v2::Frame
static String::Type checkEncoding (const StringList &fields, String::Type encoding)
 Checks a the list of string values to see if they can be used with the specified encoding and returns the recommended encoding. More...
 
static String::Type checkEncoding (const StringList &fields, String::Type encoding, unsigned int version)
 Checks a the list of string values to see if they can be used with the specified encoding and returns the recommended encoding. More...
 
static ByteVector keyToFrameID (const String &)
 Returns an appropriate ID3 frame ID for the given free-form tag key. More...
 
static String frameIDToKey (const ByteVector &)
 Returns a free-form tag name for the given ID3 frame ID. More...
 
static String keyToTXXX (const String &)
 Returns an appropriate TXXX frame description for the given free-form tag key. More...
 
static String txxxToKey (const String &)
 Returns a free-form tag name for the given ID3 frame description. More...
 
static void splitProperties (const PropertyMap &original, PropertyMap &singleFrameProperties, PropertyMap &tiplProperties, PropertyMap &tmclProperties)
 This helper function splits the PropertyMap original into three ProperytMaps singleFrameProperties, tiplProperties, and tmclProperties, such that: More...
 

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)
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::SynchronizedLyricsFrame::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::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

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