Class ID3_Frame_EQU2

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

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.

Located in /ID3/Frame/EQU2.php (line 58) 

ID3_Object
   |
   --ID3_Frame
      |
      --ID3_Frame_EQU2
Class Constant Summary
Description | Constants (details) Vars | | Methods (details)
BAND = 0
LINEAR = 1
Method Summary
Description | Constants (details) Vars | Methods (details)
ID3_Frame_EQU2 __construct ([Reader $reader = null], [ &$options = array()], Array $options)
void addAdjustment (integer $frequency, integer $adjustment)
Array getAdjustments ()
string getDevice ()
integer getInterpolation ()
void setAdjustments (Array $adjustments)
void setDevice (string $device)
void setInterpolation (integer $interpolation)
string __toString ()
Variables
Description | Vars (details) Constants (details) | Methods (details)

Inherited Variables

Inherited from ID3_Frame

ID3_Frame::$_data

Inherited from ID3_Object

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

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

  • access: public
ID3_Frame_EQU2 __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 159)

Adds a volume adjustment setting for given frequency. The frequency can have a value from 0 to 32767 Hz, and the adjustment </> +/- 64 dB with a precision of 0.001953125 dB.

  • access: public
void addAdjustment (integer $frequency, integer $adjustment)
  • integer $frequency: The frequency, in hertz.
  • integer $adjustment: The adjustment, in dB.
getAdjustments (line 149)

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

Adjustment points are ordered by frequency.

  • access: public
Array getAdjustments ()
getDevice (line 132)

Returns the device where the adjustments should apply.

  • access: public
string getDevice ()
getInterpolation (line 113)

Returns the interpolation method. The interpolation method describes which method is preferred when an interpolation between the adjustment point that follows.

  • access: public
integer getInterpolation ()
setAdjustments (line 173)

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, and the adjustment </> +/- 64 dB with a precision of 0.001953125 dB. One frequency should only be described once in the frame.

  • access: public
void setAdjustments (Array $adjustments)
  • Array $adjustments: The adjustments array.
setDevice (line 139)

Sets the device where the adjustments should apply.

  • access: public
void setDevice (string $device)
  • string $device: The device.
setInterpolation (line 122)

Sets the interpolation method. The interpolation method describes which method is preferred when an interpolation between the adjustment point that follows.

  • access: public
void setInterpolation (integer $interpolation)
  • integer $interpolation: The interpolation method code.
__toString (line 184)

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
Description | Constants (details) Vars | Methods (details)
BAND = 0 (line 65)

Interpolation type that defines that no interpolation is made. A jump from one adjustment level to another occurs in the middle between two adjustment points.

LINEAR = 1 (line 71)

Interpolation type that defines that interpolation between adjustment points is linear.

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

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