Docs For Class ID3_Frame

Description

The Relative volume adjustment frame is a more subjective function

than the previous ones. It allows the user to say how much he wants to increase/decrease the volume on each channel while 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.

There may only be one RVAD 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/RVAD.php (line 62)

ID3_Object
   |
   --ID3_Frame
      |
      --ID3_Frame_RVAD

Class Constant Summary

bass = "bass"

center = "center"

left = "left"

leftBack = "leftBack"

peakBass = "peakBass"

peakCenter = "peakCenter"

peakLeft = "peakLeft"

peakLeftBack = "peakLeftBack"

peakRight = "peakRight"

peakRightBack = "peakRightBack"

right = "right"

rightBack = "rightBack"

Method Summary

Array getAdjustments ()

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

void setAdjustments (Array $adjustments)

string __toString ()

Variables

Inherited Variables

Inherited from ID3_Frame

ID3_Frame::$_data

Inherited from ID3_Object

ID3_Object::$_reader

Methods

getAdjustments (line 184)

Returns the array containing the volume adjustments. The array must contain the following keys: right, left, peakRight, peakLeft. It may optionally contain the following keys: rightBack, leftBack, peakRightBack, peakLeftBack, center, peakCenter, bass, and peakBass.

access: public

Array getAdjustments ()

Constructor __construct (line 113)

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

access: public

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

setAdjustments (line 194)

Sets the array of volume adjustments. The array must contain the following keys: right, left, peakRight, peakLeft. It may optionally contain the following keys: rightBack, leftBack, peakRightBack, peakLeftBack, center, peakCenter, bass, and peakBass.

access: public

void setAdjustments (Array $adjustments)

Array $adjustments: The volume adjustments array.

__toString (line 204)

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

bass = "bass" (line 99)

center = "center" (line 93)

left = "left" (line 70)

leftBack = "leftBack" (line 84)

peakBass = "peakBass" (line 102)

peakCenter = "peakCenter" (line 96)

peakLeft = "peakLeft" (line 76)

peakLeftBack = "peakLeftBack" (line 90)

peakRight = "peakRight" (line 73)

peakRightBack = "peakRightBack" (line 87)

right = "right" (line 67)

rightBack = "rightBack" (line 81)

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_RVAD

Inherited Variables

Inherited Methods

Inherited Constants