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:

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)
- Public Member Functions inherited from TagLib::ID3v2::Frame
virtual ~Frame ()
ByteVector frameID () const
uint size () const
void setData (const ByteVector &data)
virtual void setText (const String &text)
ByteVector render () const
 Header (const ByteVector &data, bool synchSafeInts)
 Header (const ByteVector &data, uint version=4)
virtual ~Header ()
void setData (const ByteVector &data, bool synchSafeInts)
void setData (const ByteVector &data, uint version=4)
ByteVector frameID () const
void setFrameID (const ByteVector &id)
uint frameSize () const
void setFrameSize (uint size)
uint version () const
void setVersion (uint version)
bool tagAlterPreservation () const
void setTagAlterPreservation (bool discard)
bool fileAlterPreservation () const
bool readOnly () const
bool groupingIdentity () const
bool compression () const
bool encryption () const
bool unsynchronisation () const
bool dataLengthIndicator () const
ByteVector render () const
bool frameAlterPreservation () const

Protected Member Functions

virtual void parseFields (const ByteVector &data)
virtual ByteVector renderFields () const
- Protected Member Functions inherited from TagLib::ID3v2::Frame
 Frame (const ByteVector &data)
 Frame (Header *h)
Headerheader () const
void setHeader (Header *h, bool deleteCurrent=true)
void parse (const ByteVector &data)
ByteVector fieldData (const ByteVector &frameData) const
String readStringField (const ByteVector &data, String::Type encoding, int *positon=0)
String::Type checkTextEncoding (const StringList &fields, String::Type encoding) const
PropertyMap asProperties () const

Friends

class FrameFactory

Additional Inherited Members

- Static Public Member Functions inherited from TagLib::ID3v2::Frame
static FramecreateTextualFrame (const String &key, const StringList &values)
static uint headerSize ()
static uint headerSize (uint version)
static ByteVector textDelimiter (String::Type t)
static uint size ()
static uint size (uint version)
- Static Public Attributes inherited from TagLib::ID3v2::Frame
static const String instrumentPrefix
static const String commentPrefix
static const String lyricsPrefix
static const String urlPrefix
- Static Protected Member Functions inherited from TagLib::ID3v2::Frame
static String::Type checkEncoding (const StringList &fields, String::Type encoding)
static String::Type checkEncoding (const StringList &fields, String::Type encoding, uint version)
static ByteVector keyToFrameID (const String &)
static String frameIDToKey (const ByteVector &)
static String keyToTXXX (const String &)
static String txxxToKey (const String &)
static void splitProperties (const PropertyMap &original, PropertyMap &singleFrameProperties, PropertyMap &tiplProperties, PropertyMap &tmclProperties)

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

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