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

TagLib::ID3v2::PrivateFrame Class Reference

An implementation of ID3v2 privateframe. More...

#include <privateframe.h>

Inheritance diagram for TagLib::ID3v2::PrivateFrame:
Collaboration diagram for TagLib::ID3v2::PrivateFrame:

List of all members.

Public Member Functions

 PrivateFrame ()
 PrivateFrame (const ByteVector &data)
virtual ~PrivateFrame ()
virtual String toString () const
String owner () const
ByteVector data () const
void setOwner (const String &s)
void setData (const ByteVector &v)

Protected Member Functions

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

Friends

class FrameFactory

Detailed Description

An implementation of ID3v2 privateframe.


Constructor & Destructor Documentation

TagLib::ID3v2::PrivateFrame::PrivateFrame ( )

Construct an empty private frame.

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

Construct a private frame based on the data in data.

Note:
This is the constructor used when parsing the frame from a file.
virtual TagLib::ID3v2::PrivateFrame::~PrivateFrame ( ) [virtual]

Destroys this private frame instance.


Member Function Documentation

ByteVector TagLib::ID3v2::PrivateFrame::data ( ) const
String TagLib::ID3v2::PrivateFrame::owner ( ) const
Returns:
The owner of the private frame.
Note:
This should contain an email address or link to a website.
virtual void TagLib::ID3v2::PrivateFrame::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::PrivateFrame::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::PrivateFrame::setData ( const ByteVector data)

Sets the data that will be used as the frame. Since the length is not known before the frame has been parsed, this should just be a pointer to the first byte of the frame. It will determine the length internally and make that available through size().

Reimplemented from TagLib::ID3v2::Frame.

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

Sets the owner of the frame to s.

Note:
This should contain an email address or link to a website.
virtual String TagLib::ID3v2::PrivateFrame::toString ( ) const [virtual]

Returns the text of this private frame, currently just the owner.

See also:
text()

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: