Docs For Class ID3_Frame

Description

The Equalisation frame is another subjective, alignment frame. It allows the user to predefine an equalisation curve within the audio file.

There may only be one EQUA frame in each tag.

author: Ryan Butterfield <buttza@gmail.com>
author: Sven Vollbehr <svollbehr@gmail.com>
version: $Rev: 105 $
copyright: Copyright (c) 2008 The PHP Reader Project Workgroup
deprecated: ID3v2.3.0
license: New BSD License

Located in /ID3/Frame/EQUA.php (line 57)

ID3_Object
   |
   --ID3_Frame
      |
      --ID3_Frame_EQUA

Method Summary

ID3_Frame_EQUA __construct ([Reader $reader = null], [ &$options = array()], Array $options)

void addAdjustment (integer $frequency, integer $adjustment)

Array getAdjustments ()

void setAdjustments (Array $adjustments)

string __toString ()

Variables

Inherited Variables

Inherited from ID3_Frame

ID3_Frame::$_data

Inherited from ID3_Object

ID3_Object::$_reader

Methods

Constructor __construct (line 68)

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

access: public

ID3_Frame_EQUA __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.

addAdjustment (line 105)

Adds a volume adjustment setting for given frequency. The frequency can have a value from 0 to 32767 Hz.

access: public

void addAdjustment (integer $frequency, integer $adjustment)

integer $frequency: The frequency, in hertz.
integer $adjustment: The adjustment, in dB.

getAdjustments (line 96)

Returns the array containing adjustments having frequencies as keys and their corresponding adjustments as values.

access: public

Array getAdjustments ()

setAdjustments (line 119)

Sets the adjustments array. The array must have frequencies as keys and their corresponding adjustments as values. The frequency can have a value from 0 to 32767 Hz. One frequency should only be described once in the frame.

access: public

void setAdjustments (Array $adjustments)

Array $adjustments: The adjustments array.

__toString (line 130)

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

Inherited Constants

Inherited from ID3_Frame

ID3_Frame::COMPRESSION
ID3_Frame::DATA_LENGTH_INDICATOR
ID3_Frame::DISCARD_ON_FILECHANGE
ID3_Frame::DISCARD_ON_TAGCHANGE
ID3_Frame::ENCRYPTION
ID3_Frame::GROUPING_IDENTITY
ID3_Frame::READ_ONLY
ID3_Frame::UNSYNCHRONISATION

Class ID3_Frame_EQUA

Inherited Variables

Inherited Methods

Inherited Constants