Class ID3_Frame_RVA2

Description

The Relative volume adjustment (2) frame is a more subjective frame than

the previous ones. It allows the user to say how much he wants to increase/decrease the volume on each channel when the file is played. The purpose is to be able to align all files to a reference volume, so that you don't have to change the volume constantly. This frame may also be used to balance adjust the audio. The volume adjustment is encoded as a fixed point decibel value, 16 bit signed integer representing (adjustment*512), giving +/- 64 dB with a precision of 0.001953125 dB. E.g. +2 dB is stored as $04 00 and -2 dB is $FC 00.

There may be more than one RVA2 frame in each tag, but only one with the same identification string.

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

ID3_Object
   |
   --ID3_Frame
      |
      --ID3_Frame_RVA2
Class Constant Summary
 channelType = "channelType"
 peakVolume = "peakVolume"
 volumeAdjustment = "volumeAdjustment"
Variable Summary
static Array $types
Method Summary
ID3_Frame_RVA2 __construct ([Reader $reader = null], [ &$options = array()], Array $options)
Array getAdjustments ()
string getDevice ()
void setAdjustments (Array $adjustments)
void setDevice (string $device)
string __toString ()
Variables
static Array $types = array
("Other", "Master volume", "Front right", "Front left", "Back right",
"Back left", "Front centre", "Back centre", "Subwoofer")
(line 96)

The list of channel types.

  • access: public

Inherited Variables

Inherited from ID3_Frame

ID3_Frame::$_data

Inherited from ID3_Object

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

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

  • access: public
ID3_Frame_RVA2 __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.
getAdjustments (line 176)

Returns the array containing volume adjustments for each channel. Volume adjustments are arrays themselves containing the following keys: channelType, volumeAdjustment, peakVolume.

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

Returns the device where the adjustments should apply.

  • access: public
string getDevice ()
setAdjustments (line 185)

Sets the array of volume adjustments for each channel. Each volume adjustment is an array too containing the following keys: channelType, volumeAdjustment, peakVolume.

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

Sets the device where the adjustments should apply.

  • access: public
void setDevice (string $device)
  • string $device: The device.
__toString (line 195)

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
channelType = "channelType" (line 74)

The channel type key.

peakVolume = "peakVolume" (line 89)

The peak volume key.

volumeAdjustment = "volumeAdjustment" (line 82)

The volume adjustment key. Adjustments are +/- 64 dB with a precision of 0.001953125 dB.

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:19:17 +0300 by phpDocumentor 1.4.1