TagLib API Documentation
Public Member Functions | Protected Member Functions | Friends | List of all members
TagLib::ID3v2::OwnershipFrame Class Reference

An implementation of ID3v2 "ownership". More...

#include <ownershipframe.h>

Inheritance diagram for TagLib::ID3v2::OwnershipFrame:
Collaboration diagram for TagLib::ID3v2::OwnershipFrame:

Public Member Functions

 OwnershipFrame (String::Type encoding=String::Latin1)
 OwnershipFrame (const ByteVector &data)
 ~OwnershipFrame () override
 OwnershipFrame (const OwnershipFrame &)=delete
OwnershipFrameoperator= (const OwnershipFrame &)=delete
String toString () const override
StringList toStringList () const override
String datePurchased () const
void setDatePurchased (const String &s)
String pricePaid () const
void setPricePaid (const String &s)
String seller () const
void setSeller (const String &seller)
String::Type textEncoding () const
void setTextEncoding (String::Type encoding)
- Public Member Functions inherited from TagLib::ID3v2::Frame
virtual ~Frame ()
 Frame (const Frame &)=delete
Frameoperator= (const Frame &)=delete
ByteVector frameID () const
unsigned int size () const
unsigned int headerSize () const
void setData (const ByteVector &data)
virtual void setText (const String &text)
virtual String toString () const =0
virtual StringList toStringList () const
ByteVector render () const
Headerheader () const
 Header (const ByteVector &data, unsigned int version=4)
virtual ~Header ()
 Header (const Header &)=delete
Headeroperator= (const Header &)=delete
void setData (const ByteVector &data, unsigned int version=4)
ByteVector frameID () const
void setFrameID (const ByteVector &id)
unsigned int frameSize () const
void setFrameSize (unsigned int size)
unsigned int version () const
void setVersion (unsigned int version)
unsigned int size () const
bool tagAlterPreservation () const
void setTagAlterPreservation (bool preserve)
bool fileAlterPreservation () const
bool readOnly () const
bool groupingIdentity () const
bool compression () const
bool encryption () const
bool unsynchronisation () const
bool dataLengthIndicator () const
ByteVector render () const

Protected Member Functions

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


class FrameFactory

Additional Inherited Members

- Static Public Member Functions inherited from TagLib::ID3v2::Frame
static ByteVector textDelimiter (String::Type t)
static ByteVector keyToFrameID (const String &)
static String frameIDToKey (const ByteVector &)
- 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 void splitProperties (const PropertyMap &original, PropertyMap &singleFrameProperties, PropertyMap &tiplProperties, PropertyMap &tmclProperties)

Detailed Description

An implementation of ID3v2 "ownership".

This implements the ID3v2 ownership (OWNE frame). It consists of a price paid, a date purchased (YYYYMMDD) and the name of the seller.

Constructor & Destructor Documentation

◆ OwnershipFrame() [1/3]

TagLib::ID3v2::OwnershipFrame::OwnershipFrame ( String::Type  encoding = String::Latin1)

Construct an empty ownership frame.

◆ OwnershipFrame() [2/3]

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

Construct an ownership frame based on the data in data.

◆ ~OwnershipFrame()

TagLib::ID3v2::OwnershipFrame::~OwnershipFrame ( )

Destroys this OwnershipFrame instance.

◆ OwnershipFrame() [3/3]

TagLib::ID3v2::OwnershipFrame::OwnershipFrame ( const OwnershipFrame )

Member Function Documentation

◆ datePurchased()

String TagLib::ID3v2::OwnershipFrame::datePurchased ( ) const

Returns the date purchased.

See also

◆ operator=()

OwnershipFrame & TagLib::ID3v2::OwnershipFrame::operator= ( const OwnershipFrame )

◆ parseFields()

void TagLib::ID3v2::OwnershipFrame::parseFields ( const ByteVector data)

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.

◆ pricePaid()

String TagLib::ID3v2::OwnershipFrame::pricePaid ( ) const

Returns the price paid.

See also

◆ renderFields()

ByteVector TagLib::ID3v2::OwnershipFrame::renderFields ( ) const

Render the field data back to a binary format in a ByteVector. This must be overridden by subclasses.

Implements TagLib::ID3v2::Frame.

◆ seller()

String TagLib::ID3v2::OwnershipFrame::seller ( ) const

Returns the seller.

See also

◆ setDatePurchased()

void TagLib::ID3v2::OwnershipFrame::setDatePurchased ( const String s)

Set the date purchased.

See also

◆ setPricePaid()

void TagLib::ID3v2::OwnershipFrame::setPricePaid ( const String s)

Set the price paid.

See also

◆ setSeller()

void TagLib::ID3v2::OwnershipFrame::setSeller ( const String seller)

Set the seller.

See also

◆ setTextEncoding()

void TagLib::ID3v2::OwnershipFrame::setTextEncoding ( String::Type  encoding)

Sets the text encoding to be used when rendering this frame to encoding.

See also

◆ textEncoding()

String::Type TagLib::ID3v2::OwnershipFrame::textEncoding ( ) const

Returns the text encoding that will be used in rendering this frame. This defaults to the type that was either specified in the constructor or read from the frame when parsed.

See also

◆ toString()

String TagLib::ID3v2::OwnershipFrame::toString ( ) const

Returns price paid, date purchased and seller.

See also

Implements TagLib::ID3v2::Frame.

◆ toStringList()

StringList TagLib::ID3v2::OwnershipFrame::toStringList ( ) const

Returns price paid, date purchased and seller.

Reimplemented from TagLib::ID3v2::Frame.

Friends And Related Function Documentation

◆ FrameFactory

friend class FrameFactory

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