Logo Search packages:      
Sourcecode: f-spot version File versions  Download package

TagLib::Id3v2::SynchronisedLyricsFrame Class Reference

Inheritance diagram for TagLib::Id3v2::SynchronisedLyricsFrame:

TagLib::Id3v2::Frame

List of all members.


Detailed Description

This class extends Frame, implementing support for ID3v2 Synchronised Lyrics and Text (SYLT) Frames.

Definition at line 111 of file SynchronizedLyricsFrame.cs.


Public Member Functions

override Frame Clone ()
 Creates a deep copy of the current instance.
virtual ByteVector Render (byte version)
 Renders the current instance, encoded in a specified ID3v2 version.
 SynchronisedLyricsFrame (ByteVector data, byte version)
 Constructs and initializes a new instance of SynchronisedLyricsFrame by reading its raw data in a specified ID3v2 version.
 SynchronisedLyricsFrame (string description, string language, SynchedTextType type)
 Constructs and initializes a new instance of SynchronisedLyricsFrame with a specified description, ISO-639-2 language code, and text type.
 SynchronisedLyricsFrame (string description, string language, SynchedTextType type, StringType encoding)
 Constructs and initializes a new instance of SynchronisedLyricsFrame with a specified description, ISO-639-2 language code, text type, and text encoding.

Static Public Member Functions

static SynchronisedLyricsFrame Get (Tag tag, string description, string language, SynchedTextType type, bool create)
 Gets a specified lyrics frame from the specified tag, optionally creating it if it does not exist.
static SynchronisedLyricsFrame GetPreferred (Tag tag, string description, string language, SynchedTextType type)
 Gets a specified lyrics frame from the specified tag, trying to to match the description and language but accepting an incomplete match.
static ByteVector TextDelimiter (StringType type)
 Gets the text delimiter for a specified encoding.

Protected Member Functions

ByteVector FieldData (ByteVector frameData, int offset, byte version)
 Extracts the field data from the raw data portion of an ID3v2 frame.
override void ParseFields (ByteVector data, byte version)
 Populates the values in the current instance by parsing its field data in a specified version.
override ByteVector RenderFields (byte version)
 Renders the values in the current instance into field data for a specified version.
void SetData (ByteVector data, int offset, byte version, bool readHeader)
 Populates the current instance by reading the raw frame from disk, optionally reading the header.
internal SynchronisedLyricsFrame (ByteVector data, int offset, FrameHeader header, byte version)
 Constructs and initializes a new instance of SynchronisedLyricsFrame by reading its raw data in a specified ID3v2 version.

Static Protected Member Functions

static StringType CorrectEncoding (StringType type, byte version)
 Converts an encoding to be a supported encoding for a specified tag version.

Properties

string Description [get, set]
 Gets and sets the description stored in the current instance.
short EncryptionId [get, set]
 Gets and sets the encryption ID applied to the current instance.
FrameFlags Flags [get, set]
 Gets and sets the frame flags applied to the current instance.
TimestampFormat Format [get, set]
 Gets and sets the timestamp format used by the current instance.
ReadOnlyByteVector FrameId [get]
 Gets the frame ID for the current instance.
short GroupId [get, set]
 Gets and sets the grouping ID applied to the current instance.
string Language [get, set]
 Gets and sets the ISO-639-2 language code stored in the current instance.
uint Size [get]
 Gets the size of the current instance as it was last stored on disk.
SynchedText[] Text [get, set]
 Gets and sets the text contained in the current instance.
StringType TextEncoding [get, set]
 Gets and sets the text encoding to use when storing the current instance.
SynchedTextType Type [get, set]
 Gets and sets the type of text contained in the current instance.

Private Attributes

string description = null
 Contains the description.
StringType encoding = Tag.DefaultEncoding
 Contains the text encoding to use when rendering the current instance.
string language = null
 Contains the ISO-639-2 language code.
SynchedTextType lyrics_type = SynchedTextType.Other
 Contains the text type.
SynchedText[] text = new SynchedText [0]
 Contains the text.
TimestampFormat timestamp_format
 Contains the timestamp format.

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

Generated by  Doxygen 1.6.0   Back to index