Class ID3_Frame_POPM

Description

The purpose of the Popularimeter frame is to specify how good an audio

file is. Many interesting applications could be found to this frame such as a playlist that features better audio files more often than others or it could be used to profile a person's taste and find other good files by comparing people's profiles. The frame contains the email address to the user, one rating byte and a four byte play counter, intended to be increased with one for every time the file is played.

The rating is 1-255 where 1 is worst and 255 is best. 0 is unknown. If no personal counter is wanted it may be omitted. When the counter reaches all one's, one byte is inserted in front of the counter thus making the counter eight bits bigger in the same away as the play counter ID3_Frame_PCNT. There may be more than one POPM frame in each tag, but only one with the same email address.

Located in /ID3/Frame/POPM.php (line 66)

ID3_Object
   |
   --ID3_Frame
      |
      --ID3_Frame_POPM
Method Summary
ID3_Frame_POPM __construct ([Reader $reader = null], [ &$options = array()], Array $options)
void addCounter ()
integer getCounter ()
string getOwner ()
integer getRating ()
void setCounter (integer $counter)
void setOwner (string $owner)
void setRating (integer $rating)
string __toString ()
Variables

Inherited Variables

Inherited from ID3_Frame

ID3_Frame::$_data

Inherited from ID3_Object

ID3_Object::$_reader
Methods
Constructor __construct (line 83)

Constructs the class with given parameters and parses object related data.

  • access: public
ID3_Frame_POPM __construct ([Reader $reader = null], [ &$options = array()], Array $options)
  • Reader $reader: The reader object.
  • Array $options: The options array.
  • &$options

Redefinition of:
ID3_Frame::__construct()
Constructs the class with given parameters and reads object related data from the ID3v2 tag.
addCounter (line 138)

Adds counter by one.

  • access: public
void addCounter ()
getCounter (line 133)

Returns the counter.

  • access: public
integer getCounter ()
getOwner (line 105)

Returns the owner identifier string.

  • access: public
string getOwner ()
getRating (line 119)

Returns the user rating.

  • access: public
integer getRating ()
setCounter (line 145)

Sets the counter value.

  • access: public
void setCounter (integer $counter)
  • integer $counter: The counter value.
setOwner (line 112)

Sets the owner identifier string.

  • access: public
void setOwner (string $owner)
  • string $owner: The owner identifier string.
setRating (line 126)

Sets the user rating.

  • access: public
void setRating (integer $rating)
  • integer $rating: The user rating.
__toString (line 152)

Returns the frame raw data.

  • access: public
string __toString ()

Redefinition of:
ID3_Frame::__toString()
Returns the frame raw data.

Inherited Methods

Inherited From ID3_Frame

ID3_Frame::__construct()
ID3_Frame::getFlags()
ID3_Frame::getIdentifier()
ID3_Frame::getSize()
ID3_Frame::hasFlag()
ID3_Frame::setData()
ID3_Frame::setFlags()
ID3_Frame::setIdentifier()
ID3_Frame::__toString()

Inherited From ID3_Object

ID3_Object::__construct()
ID3_Object::decodeSynchsafe32()
ID3_Object::decodeUnsynchronisation()
ID3_Object::encodeSynchsafe32()
ID3_Object::encodeUnsynchronisation()
ID3_Object::explodeString8()
ID3_Object::explodeString16()
ID3_Object::getOption()
ID3_Object::getOptions()
ID3_Object::setOption()
ID3_Object::setOptions()
ID3_Object::__get()
ID3_Object::__set()
Class Constants

Documentation generated on Fri, 05 Sep 2008 20:19:15 +0300 by phpDocumentor 1.4.1