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)
uint counter () const
void setCounter (uint counter)
- 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

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

Friends

class FrameFactory

Additional Inherited Members

- 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)
- 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 "popularimeter".

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

Constructor & Destructor Documentation

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

Construct an empty popularimeter frame.

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

Construct a popularimeter based on the data in data.

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

Destroys this PopularimeterFrame instance.

Member Function Documentation

uint TagLib::ID3v2::PopularimeterFrame::counter ( ) const

Returns the counter.

See Also
setCounter()
String TagLib::ID3v2::PopularimeterFrame::email ( ) const

Returns the email.

See Also
setEmail()
virtual void TagLib::ID3v2::PopularimeterFrame::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.

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

Returns the rating.

See Also
setRating()
virtual ByteVector TagLib::ID3v2::PopularimeterFrame::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::PopularimeterFrame::setCounter ( uint  counter)

Set the counter.

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

Set the email.

See Also
email()
void TagLib::ID3v2::PopularimeterFrame::setRating ( int  rating)

Set the rating.

See Also
rating()
virtual String TagLib::ID3v2::PopularimeterFrame::toString ( ) const
virtual

Returns the text of this popularimeter.

See Also
text()

Implements TagLib::ID3v2::Frame.

Friends And Related Function Documentation

friend class FrameFactory
friend

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