uk.co.caprica.vlcj.player

Class Equalizer

java.lang.Object

uk.co.caprica.vlcj.player.Equalizer

public final class Equalizer
extends Object

Encapsulation of audio equalizer settings.

Equalizer amplification values are constrained to the range -20.0 Hz to 20.0 Hz, see LibVlcConst.MIN_GAIN and LibVlcConst.MAX_GAIN. Attempting to set values outside of this range will cause an IllegalArgumentException to be thrown.

After creating an equalizer, it may be associated with a media player.

See Also:

MediaPlayer.setEqualizer(Equalizer)

Constructor Summary

Constructors

Constructor and Description
Equalizer(int bandCount) Create an audio equalizer.

Method Summary

Modifier and Type	Method and Description
void	addEqualizerListener(EqualizerListener listener) Add a listener to be notified of equalizer state-change events.
float	getAmp(int index) Get an individual amplification value.
float[]	getAmps() Get the current amplification values for all frequency bands.
int	getBandCount() Get the number of distinct frequency bands in the equalizer.
float	getPreamp() Get the current pre-amplification value.
void	removeEqualizerListener(EqualizerListener listener) Remove a listener so that it is no longer notified of equalizer state-change events.
void	reset() Reset all of the equalizer amplification values (including pre-amplification) to zero.
void	setAmp(int index, float newAmp) Set an individual amplification value.
void	setAmps(float[] newAmps) Set new amplification values for all frequency bands.
void	setEqualizer(Equalizer equalizer) Set new amplification values (including pre-amplification) from another equalizer.
void	setPreamp(float newPreamp) Set a new pre-amplification value.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Equalizer

public Equalizer(int bandCount)

Create an audio equalizer.

Parameters:

bandCount - number of unique frequency bands (not including pre-amp)

Method Detail

addEqualizerListener

public final void addEqualizerListener(EqualizerListener listener)

Add a listener to be notified of equalizer state-change events.

Parameters:

listener - listener to add

removeEqualizerListener

public final void removeEqualizerListener(EqualizerListener listener)

Remove a listener so that it is no longer notified of equalizer state-change events.

Parameters:

listener - listener to remove

getBandCount

public final int getBandCount()

Get the number of distinct frequency bands in the equalizer.

Returns:

number of frequency bands

getPreamp

public final float getPreamp()

Get the current pre-amplification value.

Returns:

pre-amplification value (Hz)

setPreamp

public final void setPreamp(float newPreamp)

Set a new pre-amplification value.

Parameters:

newPreamp - pre-amplification value (Hz)

Throws:

IllegalArgumentException - if the amplification value is outside of the allowed range

getAmp

public final float getAmp(int index)

Get an individual amplification value.

Parameters:

index - index of the frequency band to get

Returns:

amplification value

Throws:

IllegalArgumentException - if the index is outside of the allowed range

setAmp

public final void setAmp(int index,
                         float newAmp)

Set an individual amplification value.

Parameters:

index - index of the frequency band to set

newAmp - amplification value

Throws:

IllegalArgumentException - if the index or amplification value is outside of the allowed range

getAmps

public final float[] getAmps()

Get the current amplification values for all frequency bands.

Returns:

current amplification values

setAmps

public final void setAmps(float[] newAmps)

Set new amplification values for all frequency bands.

Parameters:

newAmps - new amplification values

Throws:

IllegalArgumentException - if the amplification values are null, the wrong length, or outside of the allowed range

setEqualizer

public final void setEqualizer(Equalizer equalizer)

Set new amplification values (including pre-amplification) from another equalizer.

Parameters:

equalizer - equalizer to obtain values from

reset

public final void reset()

Reset all of the equalizer amplification values (including pre-amplification) to zero.

toString

public final String toString()

Overrides:

toString in class Object