Logo Search packages:      
Sourcecode: taglib-sharp version File versions

TagLib::Id3v2::CommentsFrame Class Reference

Inheritance diagram for TagLib::Id3v2::CommentsFrame:

List of all members.


Detailed Description

This class extends Frame, implementing support for ID3v2 Comments (COMM) Frames.

A CommentsFrame should be used for storing user readable comments on the media file.

When reading comments from a file, GetPreferred should be used as it gracefully falls back to comments that you, as a developer, may not be expecting. When writing comments, however, it is best to use Get as it forces it to be written in the exact version you are expecting.

Definition at line 43 of file CommentsFrame.cs.


Public Member Functions

 CommentsFrame (ByteVector data, byte version)
 Constructs and initializes a new instance of CommentsFrame by reading its raw data in a specified ID3v2 version.
 CommentsFrame (string description)
 Constructs and initializes a new instance of CommentsFrame with a specified description.
 CommentsFrame (string description, string language)
 Constructs and initializes a new instance of CommentsFrame with a specified description and ISO-639-2 language code.
 CommentsFrame (string description, string language, StringType encoding)
 Constructs and initializes a new instance of CommentsFrame with a specified description, ISO-639-2 language code, and text encoding.
virtual ByteVector Render (byte version)
override string ToString ()
 Gets a string representation of the current instance.

Static Public Member Functions

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

Protected Member Functions

internal CommentsFrame (ByteVector data, int offset, FrameHeader header, byte version)
 Constructs and initializes a new instance of CommentsFrame by reading its raw data in a specified ID3v2 version.
ByteVector FieldData (ByteVector frameData, int offset, byte version)
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)

Static Protected Member Functions

static StringType CorrectEncoding (StringType type, byte version)

Properties

string Description [get, set]
 Gets and sets the description stored in the current instance.
short EncryptionId [get, set]
FrameFlags Flags [get, set]
ReadOnlyByteVector FrameId [get]
short GroupId [get, set]
string Language [get, set]
 Gets and sets the ISO-639-2 language code stored in the current instance.
uint Size [get]
string Text [get, set]
 Gets and sets the comment text stored in the current instance.
StringType TextEncoding [get, set]
 Gets and sets the text encoding to use when storing the current instance.

Private Attributes

string description = null
 Contains the description of the current instance.
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 of the current instance.
string text = null
 Contains the comment text of the current instance.

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

Generated by  Doxygen 1.6.0   Back to index