Top Description Fields Methods
com.sun.media.jfxmedia.effects

public Interface AudioEqualizer

Known Direct Implementers
com.sun.media.jfxmediaimpl.NativeAudioEqualizer, com.sun.media.jfxmediaimpl.platform.ios.IOSMediaPlayer.NullAudioEQ

Provides an audio equalizer with up to 15 bands. Each band can have the center frequency, bandwidth, and gain set.

Field Summary

Modifier and TypeField and Description
public static final int
MAX_NUM_BANDS

The maximum number of bands the equalizer can control.

Method Summary

Modifier and TypeMethod and Description
public EqualizerBand

Returns:

instance of EqualizerBand if the band was added, null if a band with the centerFrequency already exists.
addBand
(double centerFrequency, double bandwidth, double gain)

Adds a band to the equalizer.

public boolean

Returns:

boolean value
getEnabled
()

Returns whether equalization was enabled or not.

public boolean

Returns:

true if the band was found and removed. false otherwise
removeBand
(double centerFrequency)

Removes an equalizer band with the specified center frequency.

public void
setEnabled(boolean
boolean value
bEnable
)

Turns on or off audio equalization.

Field Detail

MAX_NUM_BANDSback to summary
public static final int MAX_NUM_BANDS

The maximum number of bands the equalizer can control.

Method Detail

addBandback to summary
public EqualizerBand addBand(double centerFrequency, double bandwidth, double gain)

Adds a band to the equalizer.

Returns:EqualizerBand

instance of EqualizerBand if the band was added, null if a band with the centerFrequency already exists.

Exceptions
IllegalArgumentException:
if centerFrequency or bandwidth are < 0.0.
getEnabledback to summary
public boolean getEnabled()

Returns whether equalization was enabled or not.

Returns:boolean

boolean value

removeBandback to summary
public boolean removeBand(double centerFrequency)

Removes an equalizer band with the specified center frequency.

Returns:boolean

true if the band was found and removed. false otherwise

Exceptions
IllegalArgumentException:
if centerFrequency is negative.
setEnabledback to summary
public void setEnabled(boolean bEnable)

Turns on or off audio equalization.

Parameters
bEnable:boolean

boolean value