TagLib::ID3v2::PopularimeterFrame Class Reference

An implementation of ID3v2 "popularimeter". More...

#include <popularimeterframe.h>

Inheritance diagram for TagLib::ID3v2::PopularimeterFrame:
Collaboration diagram for TagLib::ID3v2::PopularimeterFrame:

Public Member Functions

 PopularimeterFrame ()
 PopularimeterFrame (const ByteVector &data)
virtual ~PopularimeterFrame ()
virtual String toString () const
String email () const
void setEmail (const String &email)
int rating () const
void setRating (int rating)
unsigned int counter () const
void setCounter (unsigned int counter)
- Public Member Functions inherited from TagLib::ID3v2::Frame
virtual ~Frame ()
ByteVector frameID () const
unsigned int 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, unsigned int version=4)
virtual ~Header ()
void setData (const ByteVector &data, bool synchSafeInts)
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)
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

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
PropertyMap asProperties () const


class FrameFactory

Additional Inherited Members

- Static Public Member Functions inherited from TagLib::ID3v2::Frame
static FramecreateTextualFrame (const String &key, const StringList &values)
static unsigned int headerSize ()
static unsigned int headerSize (unsigned int version)
static ByteVector textDelimiter (String::Type t)
static unsigned int size ()
static unsigned int size (unsigned int version)
- 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, unsigned int 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 "popularimeter".

This implements the ID3v2 popularimeter (POPM frame). It consists of an email, a rating and an optional counter.

Constructor & Destructor Documentation

TagLib::ID3v2::PopularimeterFrame::PopularimeterFrame ( )

Construct an empty popularimeter frame.

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

Construct a popularimeter based on the data in data.

virtual TagLib::ID3v2::PopularimeterFrame::~PopularimeterFrame ( )

Destroys this PopularimeterFrame instance.

Member Function Documentation

unsigned int TagLib::ID3v2::PopularimeterFrame::counter ( ) const

Returns the counter.

See also
String TagLib::ID3v2::PopularimeterFrame::email ( ) const

Returns the email.

See also
virtual void TagLib::ID3v2::PopularimeterFrame::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.

int TagLib::ID3v2::PopularimeterFrame::rating ( ) const

Returns the rating.

See also
virtual ByteVector TagLib::ID3v2::PopularimeterFrame::renderFields ( ) const

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::PopularimeterFrame::setCounter ( unsigned int  counter)

Set the counter.

See also
void TagLib::ID3v2::PopularimeterFrame::setEmail ( const String email)

Set the email.

See also
void TagLib::ID3v2::PopularimeterFrame::setRating ( int  rating)

Set the rating.

See also
virtual String TagLib::ID3v2::PopularimeterFrame::toString ( ) const

Returns the text of this popularimeter.

See also

Implements TagLib::ID3v2::Frame.

Friends And Related Function Documentation

friend class FrameFactory

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