Class ID3_Frame

Description
Description | Descendents | Vars (details) | Methods (details) Constants (details)

A base class for all ID3v2 frames as described in the ID3v2 frames document.

Located in /ID3/Frame.php (line 54) 

ID3_Object
   |
   --ID3_Frame
Direct descendents
Description | Descendents | Vars (details) | Methods (details) Constants (details)
Class Description
ID3_Frame_AbstractLink A base class for all the URL link frames.
ID3_Frame_AbstractText A base class for all the text frames.
ID3_Frame_AENC The Audio encryption indicates if the actual audio stream is encrypted, and by whom.
ID3_Frame_APIC The Attached picture frame contains a picture directly related to the audio file. Image format is the MIME type and subtype for the image.
ID3_Frame_ASPI Audio files with variable bit rates are intrinsically difficult to deal with
ID3_Frame_COMM The Comments frame is intended for any kind of full text information
ID3_Frame_COMR The Commercial frame enables several competing offers in the same tag by bundling all needed information. That makes this frame rather complex but it's an easier solution than if one tries to achieve the same result with several frames.
ID3_Frame_ENCR To identify with which method a frame has been encrypted the encryption method must be registered in the tag with the Encryption method registration frame.
ID3_Frame_EQU2 The Equalisation (2) is another subjective, alignment frame. It allows the user to predefine an equalisation curve within the audio file. There may be more than one EQU2 frame in each tag, but only one with the same identification string.
ID3_Frame_EQUA The Equalisation frame is another subjective, alignment frame. It allows the user to predefine an equalisation curve within the audio file.
ID3_Frame_ETCO The Event timing codes allows synchronisation with key events in the audio.
ID3_Frame_GEOB In the General encapsulated object frame any type of file can be encapsulated.
ID3_Frame_GRID The Group identification registration frame enables grouping of otherwise unrelated frames. This can be used when some frames are to be signed. To identify which frames belongs to a set of frames a group identifier must be registered in the tag with this frame.
ID3_Frame_IPLS The Involved people list is a frame containing the names of those involved, and how they were involved. There may only be one IPLS frame in each tag.
ID3_Frame_LINK The Linked information frame is used to keep information duplication
ID3_Frame_MCDI This frame is intended for music that comes from a CD, so that the CD can be
ID3_Frame_MLLT To increase performance and accuracy of jumps within a MPEG audio file, frames with time codes in different locations in the file might be useful.
ID3_Frame_OWNE The Ownership frame might be used as a reminder of a made transaction or, if signed, as proof. Note that the ID3_Frame_USER and ID3_Frame_TOWN frames are good to use in conjunction with this one.
ID3_Frame_PCNT The Play counter is simply a counter of the number of times a file has been played. The value is increased by one every time the file begins to play. There may only be one PCNT frame in each tag.
ID3_Frame_POPM The purpose of the Popularimeter frame is to specify how good an audio
ID3_Frame_POSS The Position synchronisation frame delivers information to the listener of how far into the audio stream he picked up; in effect, it states the time offset from the first frame in the stream. There may only be one POSS frame in each tag.
ID3_Frame_PRIV The Private frame is used to contain information from a software
ID3_Frame_RBUF Sometimes the server from which an audio file is streamed is aware of
ID3_Frame_RVA2 The Relative volume adjustment (2) frame is a more subjective frame than
ID3_Frame_RVAD The Relative volume adjustment frame is a more subjective function
ID3_Frame_RVRB The Reverb is yet another subjective frame, with which you can adjust
ID3_Frame_SEEK The Seek frame indicates where other tags in a file/stream can be found. The minimum offset to next tag is calculated from the end of this tag to the beginning of the next. There may only be one seek frame in a tag.
ID3_Frame_SIGN This frame enables a group of frames, grouped with the
ID3_Frame_SYLT The Synchronised lyrics/text frame is another way of incorporating the words, said or sung lyrics, in the audio file as text, this time, however, in sync with the audio. It might also be used to describing events e.g.
ID3_Frame_SYTC For a more accurate description of the tempo of a musical piece, the Synchronised tempo codes frame might be used.
ID3_Frame_USER The Terms of use frame contains a brief description of the terms of
ID3_Frame_USLT The Unsynchronised lyrics/text transcription frame contains the lyrics of the song or a text transcription of other vocal activities. There may be more than one unsynchronised lyrics/text transcription frame in each tag, but only one with the same language and content descriptor.
Class Constant Summary
Description | Descendants | Constants (details) Vars (details) | | Methods (details)
COMPRESSION = 8
DATA_LENGTH_INDICATOR = 1
DISCARD_ON_FILECHANGE = 8192
DISCARD_ON_TAGCHANGE = 16384
ENCRYPTION = 4
GROUPING_IDENTITY = 32
READ_ONLY = 4096
UNSYNCHRONISATION = 2
Variable Summary
Description | Descendents | Vars (details) | Methods (details) Constants (details)
string $_data
Method Summary
Description | Descendents | Constants (details) Vars (details) | Methods (details)
ID3_Frame __construct ([Reader $reader = null], [ &$options = array()], Array $options)
integer getFlags ( $flags)
string getIdentifier ()
integer getSize ()
boolean hasFlag (integer $flag)
void setData (string $data)
void setFlags (string $flags)
void setIdentifier (string $identifier)
string __toString ()
Variables
Description | Descendents | Vars (details) Constants (details) | Methods (details)
string $_data = "" (line 134)

Raw content of the frame.

  • access: protected

Inherited Variables

Inherited from ID3_Object

ID3_Object::$_reader
Methods
Description | Descendents | Vars (details) Constants (details) Methods (details)
Constructor __construct (line 144)

Constructs the class with given parameters and reads object related data from the ID3v2 tag.

  • todo: Only limited subset of flags are processed.
  • access: public
ID3_Frame __construct ([Reader $reader = null], [ &$options = array()], Array $options)
  • Reader $reader: The reader object.
  • Array $options: The options array.
  • &$options
Redefinition of:
ID3_Object::__construct()
Constructs the class with given parameters and reads object related data from the ID3v2 tag.
Redefined in descendants as:
getFlags (line 230)

Returns the frame flags byte.

  • access: public
integer getFlags ( $flags)
  • $flags
getIdentifier (line 196)

Returns the frame identifier string.

  • access: public
string getIdentifier ()
getSize (line 214)

Returns the size of the data in the final frame, after encryption, compression and unsynchronisation. The size is excluding the frame header.

  • access: public
integer getSize ()
Redefined in descendants as:
hasFlag (line 223)

Checks whether or not the flag is set. Returns true if the flag is set, false otherwise.

  • access: public
boolean hasFlag (integer $flag)
  • integer $flag: The flag to query.
setData (line 244)

Sets the frame raw data.

  • access: protected
void setData (string $data)
  • string $data
Redefined in descendants as:
setFlags (line 237)

Sets the frame flags byte.

  • access: public
void setFlags (string $flags)
  • string $flags: The flags byte.
setIdentifier (line 203)

Sets the frame identifier.

  • access: public
void setIdentifier (string $identifier)
  • string $identifier: The identifier.
__toString (line 255)

Returns the frame raw data.

  • access: public
string __toString ()
Redefined in descendants as:

Inherited Methods

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
Description | Descendants | Constants (details) Vars (details) | Methods (details)
COMPRESSION = 8 (line 90)

This flag indicates whether or not the frame is compressed. A Data Length Indicator byte is included in the frame.

DATA_LENGTH_INDICATOR = 1 (line 118)

This flag indicates that a data length indicator has been added to the frame.

  • since: ID3v2.4.0
DISCARD_ON_FILECHANGE = 8192 (line 68)

This flag tells the tag parser what to do with this frame if it is unknown and the file, excluding the tag, is altered. This does not apply when the audio is completely replaced with other audio data.

DISCARD_ON_TAGCHANGE = 16384 (line 61)

This flag tells the tag parser what to do with this frame if it is unknown and the tag is altered in any way. This applies to all kinds of alterations, including adding more padding and reordering the frames.

ENCRYPTION = 4 (line 102)

This flag indicates whether or not the frame is encrypted. If set, one byte indicating with which method it was encrypted will be added to the frame.

See description of the ID3_Frame_ENCR frame for more information about encryption method registration. Encryption should be done after compression. Whether or not setting this flag requires the presence of a Data Length Indicator depends on the specific algorithm used.

GROUPING_IDENTITY = 32 (line 82)

This flag indicates whether or not this frame belongs in a group with other frames. If set, a group identifier byte is added to the frame. Every frame with the same group identifier belongs to the same group.

READ_ONLY = 4096 (line 75)

This flag, if set, tells the software that the contents of this frame are intended to be read only. Changing the contents might break something, e.g. a signature.

UNSYNCHRONISATION = 2 (line 110)

This flag indicates whether or not unsynchronisation was applied to this frame.

  • since: ID3v2.4.0

Documentation generated on Fri, 05 Sep 2008 20:18:41 +0300 by phpDocumentor 1.4.1