TagLib 1.6.1 (TagLib: TagLib::ID3v2::GeneralEncapsulatedObjectFrame Class Reference)

TagLib::ID3v2::GeneralEncapsulatedObjectFrame Class Reference

An ID3v2 general encapsulated object frame implementation. More...

#include <generalencapsulatedobjectframe.h>

Inheritance diagram for TagLib::ID3v2::GeneralEncapsulatedObjectFrame:
Collaboration diagram for TagLib::ID3v2::GeneralEncapsulatedObjectFrame:

List of all members.

Public Member Functions

 GeneralEncapsulatedObjectFrame ()
 GeneralEncapsulatedObjectFrame (const ByteVector &data)
virtual ~GeneralEncapsulatedObjectFrame ()
virtual String toString () const
String::Type textEncoding () const
void setTextEncoding (String::Type encoding)
String mimeType () const
void setMimeType (const String &type)
String fileName () const
void setFileName (const String &name)
String description () const
void setDescription (const String &desc)
ByteVector object () const
void setObject (const ByteVector &object)

Protected Member Functions

virtual void parseFields (const ByteVector &data)
virtual ByteVector renderFields () const

Friends

class FrameFactory


Detailed Description

An ID3v2 general encapsulated object frame implementation.

This is an implementation of ID3v2 general encapsulated objects. Arbitrary binary data may be included in tags, stored in GEOB frames. There may be multiple GEOB frames in a single tag. Each GEOB it labelled with a content description (which may be blank), a required mime-type, and a file name (may be blank). The content description uniquely identifies the GEOB frame in the tag.


Constructor & Destructor Documentation

TagLib::ID3v2::GeneralEncapsulatedObjectFrame::GeneralEncapsulatedObjectFrame (  ) 

Constructs an empty object frame. The description, file name and text encoding should be set manually.

TagLib::ID3v2::GeneralEncapsulatedObjectFrame::GeneralEncapsulatedObjectFrame ( const ByteVector data  )  [explicit]

Constructs a GeneralEncapsulatedObjectFrame frame based on data.

Warning:
This is not data for the encapsulated object, for that use setObject(). This constructor is used when reading the frame from the disk.

virtual TagLib::ID3v2::GeneralEncapsulatedObjectFrame::~GeneralEncapsulatedObjectFrame (  )  [virtual]

Destroys the GeneralEncapsulatedObjectFrame instance.


Member Function Documentation

String TagLib::ID3v2::GeneralEncapsulatedObjectFrame::description (  )  const

Returns the content description of the object.

See also:
setDescription()

textEncoding()

setTextEncoding()

String TagLib::ID3v2::GeneralEncapsulatedObjectFrame::fileName (  )  const

Returns the file name of the object.

See also:
setFileName()

String TagLib::ID3v2::GeneralEncapsulatedObjectFrame::mimeType (  )  const

Returns the mime type of the object.

ByteVector TagLib::ID3v2::GeneralEncapsulatedObjectFrame::object (  )  const

Returns the object data as a ByteVector.

Note:
ByteVector has a data() method that returns a const char * which should make it easy to export this data to external programs.
See also:
setObject()

mimeType()

virtual void TagLib::ID3v2::GeneralEncapsulatedObjectFrame::parseFields ( const ByteVector data  )  [protected, virtual]

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::GeneralEncapsulatedObjectFrame::renderFields (  )  const [protected, virtual]

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::GeneralEncapsulatedObjectFrame::setDescription ( const String desc  ) 

Sets the content description of the object to desc.

See also:
description()

textEncoding()

setTextEncoding()

void TagLib::ID3v2::GeneralEncapsulatedObjectFrame::setFileName ( const String name  ) 

Sets the file name for the object.

See also:
fileName()

void TagLib::ID3v2::GeneralEncapsulatedObjectFrame::setMimeType ( const String type  ) 

Sets the mime type of the object.

void TagLib::ID3v2::GeneralEncapsulatedObjectFrame::setObject ( const ByteVector object  ) 

Sets the object data to data. data should be of the type specified in this frame's mime-type specification.

See also:
object()

mimeType()

setMimeType()

void TagLib::ID3v2::GeneralEncapsulatedObjectFrame::setTextEncoding ( String::Type  encoding  ) 

Set the text encoding used for the description and file name.

See also:
description()

fileName()

String::Type TagLib::ID3v2::GeneralEncapsulatedObjectFrame::textEncoding (  )  const

Returns the text encoding used for the description and file name.

See also:
setTextEncoding()

description()

fileName()

virtual String TagLib::ID3v2::GeneralEncapsulatedObjectFrame::toString (  )  const [virtual]

Returns a string containing the description, file name and mime-type

Implements TagLib::ID3v2::Frame.


Friends And Related Function Documentation

friend class FrameFactory [friend]

Reimplemented from TagLib::ID3v2::Frame.


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