TagLib::ID3v2::UniqueFileIdentifierFrame Class Reference

An implementation of ID3v2 unique identifier frames. More...

#include <uniquefileidentifierframe.h>

Inheritance diagram for TagLib::ID3v2::UniqueFileIdentifierFrame:
Collaboration diagram for TagLib::ID3v2::UniqueFileIdentifierFrame:

Public Member Functions

 UniqueFileIdentifierFrame (const ByteVector &data)
 UniqueFileIdentifierFrame (const String &owner, const ByteVector &id)
 ~UniqueFileIdentifierFrame ()
String owner () const
ByteVector identifier () const
void setOwner (const String &s)
void setIdentifier (const ByteVector &v)
virtual String toString () const
PropertyMap asProperties () const
- 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

Static Public Member Functions

static UniqueFileIdentifierFramefindByOwner (const Tag *tag, const String &o)
- 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)

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

Friends

class FrameFactory

Additional Inherited Members

- 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 implementation of ID3v2 unique identifier frames.

This is an implementation of ID3v2 unique file identifier frames. This frame is used to identify the file in an arbitrary database identified by the owner field.

Constructor & Destructor Documentation

TagLib::ID3v2::UniqueFileIdentifierFrame::UniqueFileIdentifierFrame ( const ByteVector data)

Creates a uniqe file identifier frame based on data.

TagLib::ID3v2::UniqueFileIdentifierFrame::UniqueFileIdentifierFrame ( const String owner,
const ByteVector id 
)

Creates a unique file identifier frame with the owner owner and the identification id.

TagLib::ID3v2::UniqueFileIdentifierFrame::~UniqueFileIdentifierFrame ( )

Destroys the frame.

Member Function Documentation

PropertyMap TagLib::ID3v2::UniqueFileIdentifierFrame::asProperties ( ) const

Parses the contents of this frame as PropertyMap. If that fails, the returend PropertyMap will be empty, and its unsupportedData() will contain this frame's ID. BIC: Will be a virtual function in future releases.

Reimplemented from TagLib::ID3v2::Frame.

static UniqueFileIdentifierFrame* TagLib::ID3v2::UniqueFileIdentifierFrame::findByOwner ( const Tag tag,
const String o 
)
static

UFID frames each have a unique owner. This searches for a UFID frame with the owner o and returns a pointer to it.

See Also
owner()
ByteVector TagLib::ID3v2::UniqueFileIdentifierFrame::identifier ( ) const

Returns the unique identifier. Though sometimes this is a text string it also may be binary data and as much should be assumed when handling it.

String TagLib::ID3v2::UniqueFileIdentifierFrame::owner ( ) const

Returns the owner for the frame; essentially this is the key for determining which identification scheme this key belongs to. This will usually either be an email address or URL for the person or tool used to create the unique identifier.

See Also
setOwner()
virtual void TagLib::ID3v2::UniqueFileIdentifierFrame::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::UniqueFileIdentifierFrame::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::UniqueFileIdentifierFrame::setIdentifier ( const ByteVector v)

Sets the unique file identifier to v.

See Also
identifier()
void TagLib::ID3v2::UniqueFileIdentifierFrame::setOwner ( const String s)

Sets the owner of the identification scheme to s.

See Also
owner()
virtual String TagLib::ID3v2::UniqueFileIdentifierFrame::toString ( ) const
virtual

This returns the textual representation of the data in the frame. Subclasses must reimplement this method to provide a string representation of the frame's data.

Implements TagLib::ID3v2::Frame.

Friends And Related Function Documentation

friend class FrameFactory
friend

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