TagLib 1.11 (TagLib: TagLib::ID3v2::UniqueFileIdentifierFrame Class Reference)

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:

List of all members.

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

Static Public Member Functions

static UniqueFileIdentifierFramefindByOwner (const Tag *tag, const String &o)

Protected Member Functions

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

Friends

class FrameFactory


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 unique 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

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()

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.

void TagLib::ID3v2::UniqueFileIdentifierFrame::setOwner ( const String s  ) 

Sets the owner of the identification scheme to s.

See also:
owner()

void TagLib::ID3v2::UniqueFileIdentifierFrame::setIdentifier ( const ByteVector v  ) 

Sets the unique file identifier to v.

See also:
identifier()

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.

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()

virtual void TagLib::ID3v2::UniqueFileIdentifierFrame::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::UniqueFileIdentifierFrame::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.


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: