Miam-Player  0.8.0
A nice music player
TagLib::ID3v2::GeneralEncapsulatedObjectFrame Class Reference

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

#include <generalencapsulatedobjectframe.h>

Inheritance diagram for TagLib::ID3v2::GeneralEncapsulatedObjectFrame:
TagLib::ID3v2::Frame TagLib::ID3v2::Header

Public Member Functions

 GeneralEncapsulatedObjectFrame ()
 Constructs an empty object frame. More...
 
 GeneralEncapsulatedObjectFrame (const ByteVector &data)
 Constructs a GeneralEncapsulatedObjectFrame frame based on data. More...
 
virtual ~GeneralEncapsulatedObjectFrame ()
 Destroys the GeneralEncapsulatedObjectFrame instance. More...
 
virtual String toString () const
 Returns a string containing the description, file name and mime-type. More...
 
String::Type textEncoding () const
 Returns the text encoding used for the description and file name. More...
 
void setTextEncoding (String::Type encoding)
 Set the text encoding used for the description and file name. More...
 
String mimeType () const
 Returns the mime type of the object. More...
 
void setMimeType (const String &type)
 Sets the mime type of the object. More...
 
String fileName () const
 Returns the file name of the object. More...
 
void setFileName (const String &name)
 Sets the file name for the object. More...
 
String description () const
 Returns the content description of the object. More...
 
void setDescription (const String &desc)
 Sets the content description of the object to desc. More...
 
ByteVector object () const
 Returns the object data as a ByteVector. More...
 
void setObject (const ByteVector &object)
 Sets the object data to data. More...
 
- Public Member Functions inherited from TagLib::ID3v2::Frame
virtual ~Frame ()
 Destroys this Frame instance. More...
 
ByteVector frameID () const
 Returns the Frame ID (Structure, 4) (Frames, 4) More...
 
unsigned int size () const
 Returns the size of the frame. More...
 
void setData (const ByteVector &data)
 Sets the data that will be used as the frame. More...
 
virtual void setText (const String &text)
 Set the text of frame in the sanest way possible. More...
 
ByteVector render () const
 Render the frame back to its binary format in a ByteVector. More...
 
 Header (const ByteVector &data, bool synchSafeInts)
 Construct a Frame Header based on data. More...
 
 Header (const ByteVector &data, unsigned int version=4)
 Construct a Frame Header based on data. More...
 
virtual ~Header ()
 Destroys this Header instance. More...
 
void setData (const ByteVector &data, bool synchSafeInts)
 Sets the data for the Header. More...
 
void setData (const ByteVector &data, unsigned int version=4)
 Sets the data for the Header. More...
 
ByteVector frameID () const
 Returns the Frame ID (Structure, 4) (Frames, 4) More...
 
void setFrameID (const ByteVector &id)
 Sets the frame's ID to id. More...
 
unsigned int frameSize () const
 Returns the size of the frame data portion, as set when setData() was called or set explicitly via setFrameSize(). More...
 
void setFrameSize (unsigned int size)
 Sets the size of the frame data portion. More...
 
unsigned int version () const
 Returns the ID3v2 version of the header, as passed in from the construction of the header or set via setVersion(). More...
 
void setVersion (unsigned int version)
 Sets the ID3v2 version of the header, changing has impact on the correct parsing/rendering of frame data. More...
 
bool tagAlterPreservation () const
 Returns true if the flag for tag alter preservation is set. More...
 
void setTagAlterPreservation (bool discard)
 Sets the flag for preservation of this frame if the tag is set. More...
 
bool fileAlterPreservation () const
 Returns true if the flag for file alter preservation is set. More...
 
bool readOnly () const
 Returns true if the frame is meant to be read only. More...
 
bool groupingIdentity () const
 Returns true if the flag for the grouping identity is set. More...
 
bool compression () const
 Returns true if compression is enabled for this frame. More...
 
bool encryption () const
 Returns true if encryption is enabled for this frame. More...
 
bool unsycronisation () const
 
bool unsynchronisation () const
 Returns true if unsynchronisation is enabled for this frame. More...
 
bool dataLengthIndicator () const
 Returns true if the flag for a data length indicator is set. More...
 
ByteVector render () const
 Render the Header back to binary format in a ByteVector. More...
 
bool frameAlterPreservation () const
 

Protected Member Functions

virtual void parseFields (const ByteVector &data)
 Called by parse() to parse the field data. More...
 
virtual ByteVector renderFields () const
 Render the field data back to a binary format in a ByteVector. More...
 
- Protected Member Functions inherited from TagLib::ID3v2::Frame
 Frame (const ByteVector &data)
 Constructs an ID3v2 frame using data to read the header information. More...
 
 Frame (Header *h)
 This creates an Frame using the header h. More...
 
Headerheader () const
 Returns a pointer to the frame header. More...
 
void setHeader (Header *h, bool deleteCurrent=true)
 Sets the header to h. More...
 
void parse (const ByteVector &data)
 Called by setData() to parse the frame data. More...
 
ByteVector fieldData (const ByteVector &frameData) const
 Returns a ByteVector containing the field data given the frame data. More...
 
String readStringField (const ByteVector &data, String::Type encoding, int *positon=0)
 Reads a String of type encoding from the ByteVector data. More...
 
String::Type checkTextEncoding (const StringList &fields, String::Type encoding) const
 Checks a the list of string values to see if they can be used with the specified encoding and returns the recommended encoding. More...
 
PropertyMap asProperties () const
 Parses the contents of this frame as PropertyMap. More...
 

Friends

class FrameFactory
 

Additional Inherited Members

- Static Public Member Functions inherited from TagLib::ID3v2::Frame
static FramecreateTextualFrame (const String &key, const StringList &values)
 Creates a textual frame which corresponds to a single key in the PropertyMap interface. More...
 
static unsigned int headerSize ()
 Returns the size of the frame header. More...
 
static unsigned int headerSize (unsigned int version)
 Returns the size of the frame header for the given ID3v2 version. More...
 
static ByteVector textDelimiter (String::Type t)
 Returns the text delimiter that is used between fields for the string type t. More...
 
static unsigned int size ()
 Returns the size of the frame header in bytes. More...
 
static unsigned int size (unsigned int version)
 Returns the size of the frame header in bytes for the ID3v2 version that's given. More...
 
- Static Public Attributes inherited from TagLib::ID3v2::Frame
static const String instrumentPrefix
 The string with which an instrument name is prefixed to build a key in a PropertyMap; used to translate PropertyMaps to TMCL frames. More...
 
static const String commentPrefix
 The PropertyMap key prefix which triggers the use of a COMM frame instead of a TXXX frame for a non-standard key. More...
 
static const String lyricsPrefix
 The PropertyMap key prefix which triggers the use of a USLT frame instead of a TXXX frame for a non-standard key. More...
 
static const String urlPrefix
 The PropertyMap key prefix which triggers the use of a WXXX frame instead of a TXX frame for a non-standard key. More...
 
- Static Protected Member Functions inherited from TagLib::ID3v2::Frame
static String::Type checkEncoding (const StringList &fields, String::Type encoding)
 Checks a the list of string values to see if they can be used with the specified encoding and returns the recommended encoding. More...
 
static String::Type checkEncoding (const StringList &fields, String::Type encoding, unsigned int version)
 Checks a the list of string values to see if they can be used with the specified encoding and returns the recommended encoding. More...
 
static ByteVector keyToFrameID (const String &)
 Returns an appropriate ID3 frame ID for the given free-form tag key. More...
 
static String frameIDToKey (const ByteVector &)
 Returns a free-form tag name for the given ID3 frame ID. More...
 
static String keyToTXXX (const String &)
 Returns an appropriate TXXX frame description for the given free-form tag key. More...
 
static String txxxToKey (const String &)
 Returns a free-form tag name for the given ID3 frame description. More...
 
static void splitProperties (const PropertyMap &original, PropertyMap &singleFrameProperties, PropertyMap &tiplProperties, PropertyMap &tmclProperties)
 This helper function splits the PropertyMap original into three ProperytMaps singleFrameProperties, tiplProperties, and tmclProperties, such that: More...
 

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: