org.blinkenlights.jid3.v2
Class EQUAID3V2Frame.Adjustment

java.lang.Object
  extended byorg.blinkenlights.jid3.v2.EQUAID3V2Frame.Adjustment
Enclosing class:
EQUAID3V2Frame

public class EQUAID3V2Frame.Adjustment
extends java.lang.Object

Adjustment details for specific frequencies in EQUA frame.


Constructor Summary
EQUAID3V2Frame.Adjustment(boolean bIncrement, int iFrequency, byte[] abyAdjustment)
          Constructor.
 
Method Summary
 boolean equals(java.lang.Object oOther)
           
 byte[] getAdjustment()
          Get the frequency adjustment bytes.
 int getFrequency()
          Get the frequency to be adjusted.
 boolean isDecrement()
          Check if this adjustment is a volume decrease.
 boolean isIncrement()
          Check if this adjustment is a volume boost.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EQUAID3V2Frame.Adjustment

public EQUAID3V2Frame.Adjustment(boolean bIncrement,
                                 int iFrequency,
                                 byte[] abyAdjustment)
                          throws ID3Exception
Constructor. Note: Adjustment bytes must be provided explicitly, because they could be most of least significant byte order. This is up to the implementor.

Parameters:
bIncrement - true if this adjustment is a volume boost, false otherwise
iFrequency - the frequency to be adjusted (0-32767Hz)
abyAdjustment - the adjustment bytes (note the number of bits must correspond to the adjustment bits precision set for this frame, although the format for this frame is otherwise undefined)
Throws:
ID3Exception - if the frequency specified is not in the valid range
ID3Exception - if the adjustment bytes are not provided
Method Detail

isIncrement

public boolean isIncrement()
Check if this adjustment is a volume boost.

Returns:
true is the adjustment is a volume boost, false otherwise

isDecrement

public boolean isDecrement()
Check if this adjustment is a volume decrease. (Note this method is the negative value of isIncrement().

Returns:
true if this adjustment is a volume decrease, false otherwise.

getFrequency

public int getFrequency()
Get the frequency to be adjusted.

Returns:
the frequency to be adjusted, in Hertz.

getAdjustment

public byte[] getAdjustment()
Get the frequency adjustment bytes. Note, the specific application needs to know how these were written, to make any proper use of them.

Returns:
the frequency adjustment bytes

equals

public boolean equals(java.lang.Object oOther)