org.blinkenlights.jid3.v2
Class RVRBID3V2Frame

java.lang.Object
  extended byorg.blinkenlights.jid3.v2.ID3V2Frame
      extended byorg.blinkenlights.jid3.v2.RVRBID3V2Frame
All Implemented Interfaces:
ID3Subject, ID3Visitable

public class RVRBID3V2Frame
extends ID3V2Frame

Frame containing reverb information.


Constructor Summary
RVRBID3V2Frame(java.io.InputStream oIS)
           
RVRBID3V2Frame(int iReverbLeftMS, int iReverbRightMS, int iReverbBouncesLeft, int iReverbBouncesRight, int iReverbFeedbackLeftToLeft, int iReverbFeedbackLeftToRight, int iReverbFeedbackRightToRight, int iReverbFeedbackRightToLeft, int iPremixLeftToRight, int iPremixRightToLeft)
          Creates a new instance of RVRBID3V2Frame.
 
Method Summary
 void accept(ID3Visitor oID3Visitor)
          Accept a visitor.
 boolean equals(java.lang.Object oOther)
           
protected  byte[] getFrameId()
          Get the four bytes which uniquely specify of which type this frame is.
 int getPremixLeftToRight()
           
 int getPremixRightToLeft()
           
 int getReverbBouncesLeft()
           
 int getReverbBouncesRight()
           
 int getReverbFeedbackLeftToLeft()
           
 int getReverbFeedbackLeftToRight()
           
 int getReverbFeedbackRightToLeft()
           
 int getReverbFeedbackRightToRight()
           
 int getReverbLeftMS()
           
 int getReverbRightMS()
           
 void setReverbDetails(int iReverbLeftMS, int iReverbRightMS, int iReverbBouncesLeft, int iReverbBouncesRight, int iReverbFeedbackLeftToLeft, int iReverbFeedbackLeftToRight, int iReverbFeedbackRightToRight, int iReverbFeedbackRightToLeft, int iPremixLeftToRight, int iPremixRightToLeft)
          Set the reverb details for this track.
 java.lang.String toString()
          Represent the contents of this frame as a string.
protected  void writeBody(ID3DataOutputStream oIDOS)
          Write the body of the frame to an ID3 data output stream.
 
Methods inherited from class org.blinkenlights.jid3.v2.ID3V2Frame
addID3Observer, getEncryptionMethod, isEncrypted, notifyID3Observers, removeID3Observer, setCompressionFlag, setEncryption, setFileAlterPreservationFlag, setGroupingIdentityFlag, setReadOnlyFlag, setTagAlterPreservationFlag, write, writeHeader
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RVRBID3V2Frame

public RVRBID3V2Frame(int iReverbLeftMS,
                      int iReverbRightMS,
                      int iReverbBouncesLeft,
                      int iReverbBouncesRight,
                      int iReverbFeedbackLeftToLeft,
                      int iReverbFeedbackLeftToRight,
                      int iReverbFeedbackRightToRight,
                      int iReverbFeedbackRightToLeft,
                      int iPremixLeftToRight,
                      int iPremixRightToLeft)
               throws ID3Exception
Creates a new instance of RVRBID3V2Frame.

Parameters:
iReverbLeftMS - the delay between bounces in milliseconds for the left channel (16-bit unsigned)
iReverbRightMS - the delay between bounces in milliseconds for the right channel (16-bit unsigned)
iReverbBouncesLeft - the number of bounces to make in the left channel (unsigned byte)
iReverbBouncesRight - the number of bounces to make in the right channel (unsigned byte)
iReverbFeedbackLeftToLeft - percentage of feedback from left to left (0-255)
iReverbFeedbackLeftToRight - percentage of feedback from left to right (0-255)
iReverbFeedbackRightToRight - percentage of feedback from right to right (0-255)
iReverbFeedbackRightToLeft - percentage of feedback from right to left (0-255)
iPremixLeftToRight - percentage of left channel mixed to right before reverb (0-255)
iPremixRightToLeft - percentage of right channel mixed to left before reverb (0-255)
Throws:
ID3Exception - if any value is out of its valid range

RVRBID3V2Frame

public RVRBID3V2Frame(java.io.InputStream oIS)
               throws ID3Exception
Method Detail

accept

public void accept(ID3Visitor oID3Visitor)
Description copied from interface: ID3Visitable
Accept a visitor.

Parameters:
oID3Visitor - a visitor of this object

setReverbDetails

public void setReverbDetails(int iReverbLeftMS,
                             int iReverbRightMS,
                             int iReverbBouncesLeft,
                             int iReverbBouncesRight,
                             int iReverbFeedbackLeftToLeft,
                             int iReverbFeedbackLeftToRight,
                             int iReverbFeedbackRightToRight,
                             int iReverbFeedbackRightToLeft,
                             int iPremixLeftToRight,
                             int iPremixRightToLeft)
                      throws ID3Exception
Set the reverb details for this track.

Parameters:
iReverbLeftMS - the delay between bounces in milliseconds for the left channel (16-bit unsigned)
iReverbRightMS - the delay between bounces in milliseconds for the right channel (16-bit unsigned)
iReverbBouncesLeft - the number of bounces to make in the left channel (unsigned byte)
iReverbBouncesRight - the number of bounces to make in the right channel (unsigned byte)
iReverbFeedbackLeftToLeft - percentage of feedback from left to left (0-255)
iReverbFeedbackLeftToRight - percentage of feedback from left to right (0-255)
iReverbFeedbackRightToRight - percentage of feedback from right to right (0-255)
iReverbFeedbackRightToLeft - percentage of feedback from right to left (0-255)
iPremixLeftToRight - percentage of left channel mixed to right before reverb (0-255)
iPremixRightToLeft - percentage of right channel mixed to left before reverb (0-255)
Throws:
ID3Exception - if any value is out of its valid range

getReverbLeftMS

public int getReverbLeftMS()

getReverbRightMS

public int getReverbRightMS()

getReverbBouncesLeft

public int getReverbBouncesLeft()

getReverbBouncesRight

public int getReverbBouncesRight()

getReverbFeedbackLeftToLeft

public int getReverbFeedbackLeftToLeft()

getReverbFeedbackLeftToRight

public int getReverbFeedbackLeftToRight()

getReverbFeedbackRightToRight

public int getReverbFeedbackRightToRight()

getReverbFeedbackRightToLeft

public int getReverbFeedbackRightToLeft()

getPremixLeftToRight

public int getPremixLeftToRight()

getPremixRightToLeft

public int getPremixRightToLeft()

getFrameId

protected byte[] getFrameId()
Description copied from class: ID3V2Frame
Get the four bytes which uniquely specify of which type this frame is.

Specified by:
getFrameId in class ID3V2Frame

toString

public java.lang.String toString()
Description copied from class: ID3V2Frame
Represent the contents of this frame as a string. For debugging purposes.

Specified by:
toString in class ID3V2Frame
Returns:
a string representing this frame

writeBody

protected void writeBody(ID3DataOutputStream oIDOS)
                  throws java.io.IOException
Description copied from class: ID3V2Frame
Write the body of the frame to an ID3 data output stream.

Specified by:
writeBody in class ID3V2Frame
Parameters:
oIDOS - the output stream to write to
Throws:
java.io.IOException

equals

public boolean equals(java.lang.Object oOther)