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

TagLib::Id3v2::AttachedPictureFrame Class Reference

Inheritance diagram for TagLib::Id3v2::AttachedPictureFrame:

List of all members.


Detailed Description

This class extends Frame, implementing support for ID3v2 Attached Picture (APIC) Frames.

A AttachedPictureFrame is used for storing pictures that complement the media, including the album cover, the physical medium, leaflets, file icons, etc. Other file and object data can be encapulsated via GeneralEncapsulatedObjectFrame.

Additionally, TagLib.Tag.Pictures provides a generic way or getting and setting pictures which is preferable to format specific code.

Definition at line 47 of file AttachedPictureFrame.cs.


Public Member Functions

 AttachedPictureFrame (ByteVector data, byte version)
 Constructs and initializes a new instance of AttachedPictureFrame by reading its raw data in a specified ID3v2 version.
 AttachedPictureFrame (IPicture picture)
 Constructs and initializes a new instance of AttachedPictureFrame by populating it with the contents of another IPicture object.
 AttachedPictureFrame ()
 Constructs and initializes a new instance of AttachedPictureFrame with no contents and the default values.
virtual ByteVector Render (byte version)
override string ToString ()
 Gets a string representation of the current instance.

Static Public Member Functions

static AttachedPictureFrame Get (Tag tag, string description, PictureType type, bool create)
 Gets a specified picture frame from the specified tag, optionally creating it if it does not exist.
static AttachedPictureFrame Get (Tag tag, PictureType type, bool create)
 Gets a specified picture frame from the specified tag, optionally creating it if it does not exist.
static AttachedPictureFrame Get (Tag tag, string description, bool create)
 Gets a specified picture frame from the specified tag, optionally creating it if it does not exist.
static ByteVector TextDelimiter (StringType type)

Protected Member Functions

internal AttachedPictureFrame (ByteVector data, int offset, FrameHeader header, byte version)
 Constructs and initializes a new instance of AttachedPictureFrame 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.
void ParseRawData ()
 Performs the actual parsing of the raw data.
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

ByteVector Data [get, set]
 Gets and sets the image data stored in the current instance.
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 MimeType [get, set]
 Gets and sets the mime type stored in the current instance.
uint Size [get]
StringType TextEncoding [get, set]
 Gets and sets the text encoding to use when storing the current instance.
PictureType Type [get, set]
 Gets and sets the picture type stored in the current instance.

Private Attributes

ByteVector data = null
 Contains the picture data.
string description = null
 Contains the description.
string mime_type = null
 Contains the mime type of data.
ByteVector raw_data = null
 Contains the raw field data of the current instance as sent to ParseFields or if ParseFields has not been called or ParseRawData has been called.
byte raw_version = 0
 Contains the ID3v2 version raw_data is stored in.
StringType text_encoding = Tag.DefaultEncoding
 Contains the text encoding to use when rendering.
PictureType type = PictureType.Other
 Contains the type of picture.

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

Generated by  Doxygen 1.6.0   Back to index