Class ID3_Frame_RVRB

Description

The Reverb is yet another subjective frame, with which you can adjust

echoes of different kinds. Reverb left/right is the delay between every bounce in milliseconds. Reverb bounces left/right is the number of bounces that should be made. $FF equals an infinite number of bounces. Feedback is the amount of volume that should be returned to the next echo bounce. $00 is 0%, $FF is 100%. If this value were $7F, there would be 50% volume reduction on the first bounce, 50% of that on the second and so on. Left to left means the sound from the left bounce to be played in the left speaker, while left to right means sound from the left bounce to be played in the right speaker.

Premix left to right is the amount of left sound to be mixed in the right before any reverb is applied, where $00 id 0% and $FF is 100%. Premix right to left does the same thing, but right to left. Setting both premix to $FF would result in a mono output (if the reverb is applied symmetric). There may only be one RVRB frame in each tag.

Located in /ID3/Frame/RVRB.php (line 67)

ID3_Object
   |
   --ID3_Frame
      |
      --ID3_Frame_RVRB
Method Summary
ID3_Frame_RVRB __construct ([Reader $reader = null], [ &$options = array()], Array $options)
integer getPremixLtoR ()
integer getPremixRtoL ()
integer getReverbLeft ()
integer getReverbRight ()
void setPremixLtoR (integer $premixLtoR)
void setPremixRtoL (integer $premixRtoL)
void setReverbBouncesLeft (integer $reverbBouncesLeft)
void setReverbBouncesRight (integer $reverbBouncesRight)
void setReverbFeedbackLtoL (integer $reverbFeedbackLtoL)
void setReverbFeedbackLtoR (integer $reverbFeedbackLtoR)
void setReverbFeedbackRtoL (integer $reverbFeedbackRtoL)
void setReverbFeedbackRtoR (integer $reverbFeedbackRtoR)
void setReverbLeft (integer $reverbLeft)
void setReverbRight (integer $reverbRight)
string __toString ()
Variables

Inherited Variables

Inherited from ID3_Frame

ID3_Frame::$_data

Inherited from ID3_Object

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

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

  • access: public
ID3_Frame_RVRB __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.
getPremixLtoR (line 265)

Returns the left-to-right premix.

  • access: public
integer getPremixLtoR ()
getPremixRtoL (line 282)

Returns the right-to-left premix.

  • access: public
integer getPremixRtoL ()
getReverbBouncesLeft (line 163)

Returns the left reverb bounces.

  • access: public
integer getReverbBouncesLeft ()
getReverbBouncesRight (line 180)

Returns the right reverb bounces.

  • access: public
integer getReverbBouncesRight ()
getReverbFeedbackLtoL (line 197)

Returns the left-to-left reverb feedback.

  • access: public
integer getReverbFeedbackLtoL ()
getReverbFeedbackLtoR (line 214)

Returns the left-to-right reverb feedback.

  • access: public
integer getReverbFeedbackLtoR ()
getReverbFeedbackRtoL (line 248)

Returns the right-to-left reverb feedback.

  • access: public
integer getReverbFeedbackRtoL ()
getReverbFeedbackRtoR (line 231)

Returns the right-to-right reverb feedback.

  • access: public
integer getReverbFeedbackRtoR ()
getReverbLeft (line 129)

Returns the left reverb.

  • access: public
integer getReverbLeft ()
getReverbRight (line 146)

Returns the right reverb.

  • access: public
integer getReverbRight ()
setPremixLtoR (line 272)

Sets the left-to-right premix.

  • access: public
void setPremixLtoR (integer $premixLtoR)
  • integer $premixLtoR: The left-to-right premix.
setPremixRtoL (line 289)

Sets the right-to-left premix.

  • access: public
void setPremixRtoL (integer $premixRtoL)
  • integer $premixRtoL: The right-to-left premix.
setReverbBouncesLeft (line 170)

Sets the left reverb bounces.

  • access: public
void setReverbBouncesLeft (integer $reverbBouncesLeft)
  • integer $reverbBouncesLeft: The left reverb bounces.
setReverbBouncesRight (line 187)

Sets the right reverb bounces.

  • access: public
void setReverbBouncesRight (integer $reverbBouncesRight)
  • integer $reverbBouncesRight: The right reverb bounces.
setReverbFeedbackLtoL (line 204)

Sets the left-to-left reverb feedback.

  • access: public
void setReverbFeedbackLtoL (integer $reverbFeedbackLtoL)
  • integer $reverbFeedbackLtoL: The left-to-left reverb feedback.
setReverbFeedbackLtoR (line 221)

Sets the left-to-right reverb feedback.

  • access: public
void setReverbFeedbackLtoR (integer $reverbFeedbackLtoR)
  • integer $reverbFeedbackLtoR: The left-to-right reverb feedback.
setReverbFeedbackRtoL (line 255)

Sets the right-to-left reverb feedback.

  • access: public
void setReverbFeedbackRtoL (integer $reverbFeedbackRtoL)
  • integer $reverbFeedbackRtoL: The right-to-left reverb feedback.
setReverbFeedbackRtoR (line 238)

Sets the right-to-right reverb feedback.

  • access: public
void setReverbFeedbackRtoR (integer $reverbFeedbackRtoR)
  • integer $reverbFeedbackRtoR: The right-to-right reverb feedback.
setReverbLeft (line 136)

Sets the left reverb.

  • access: public
void setReverbLeft (integer $reverbLeft)
  • integer $reverbLeft: The left reverb.
setReverbRight (line 153)

Sets the right reverb.

  • access: public
void setReverbRight (integer $reverbRight)
  • integer $reverbRight: The right reverb.
__toString (line 299)

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

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