javafx.scene.media
Class AudioEqualizer
- javafx.scene.media.AudioEqualizer
public final class AudioEqualizer extends Object
The
AudioEqualizer class provides audio equalization control for a media player. It contains an ObservableList of EqualizerBand elements. Each AudioEqualizer instance is connected to a MediaPlayer and may be obtained using the MediaPlayer.getAudioEqualizer method.Since:
JavaFX 2.0
See Also:
-
Property Summary
All MethodsInstance MethodsConcrete Methods Type Property and Description BooleanPropertyenabledWhether theAudioEqualizeris enabled.
-
Field Summary
Fields Modifier and Type Field and Description static intMAX_NUM_BANDSMaximum number of bands anAudioEqualizermay contain.
-
Method Summary
All MethodsInstance MethodsConcrete Methods Modifier and Type Method and Description BooleanPropertyenabledProperty()Whether theAudioEqualizeris enabled.ObservableList<EqualizerBand>getBands()ObservableList containingEqualizerBandelements.booleanisEnabled()Return enabled state of the AudioEqualizer.voidsetEnabled(boolean value)Enables or disablesAudioEqualizer.
-
Property Detail
-
enabled
public BooleanProperty enabledProperty
Whether theAudioEqualizeris enabled. The default value istrue.See Also:
-
-
Field Detail
-
MAX_NUM_BANDS
public static final int MAX_NUM_BANDS
Maximum number of bands anAudioEqualizermay contain. In the current implementation this value is64.See Also:
-
-
Method Detail
-
getBands
public final ObservableList<EqualizerBand> getBands()
ObservableList containingEqualizerBandelements. The content of the sequence may be changed by adding or removingEqualizerBandelements. When adding elements, the user must be prepared to catchIllegalArgumentExceptions because the internal list is aVetoableObservableListand any change to the list can be vetoed if a newly added instance is not valid.The constraints for a valid
EqualizerBandinstance are:-
EqualizerBand.centerFrequency> 0 -
EqualizerBand.bandwidth> 0 -
EqualizerBand.MIN_GAIN≤EqualizerBand.gain≤EqualizerBand.MAX_GAIN
The default set of bands is as in the following table; all bands have unity gain (0 dB).
Band Index Center Frequency (Hz) Bandwidth (Hz) 0 32 19 1 64 39 2 125 78 3 250 156 4 500 312 5 1000 625 6 2000 1250 7 4000 2500 8 8000 5000 9 16000 10000 Returns:
ObservableList containing
EqualizerBandelements.Throws:
-
-
setEnabled
public final void setEnabled(boolean value)
Enables or disablesAudioEqualizer. If the enabled property is set to false,AudioEqualizersettings are preserved but not taken into account during playback, which is equivalent to setting allEqualizerBand.gainproperties to zero.
-
isEnabled
public final boolean isEnabled()
Return enabled state of the AudioEqualizer.Returns:
true if AudioEqulizer is enabled, false otherwise.
-
enabledProperty
public BooleanProperty enabledProperty()
Whether theAudioEqualizeris enabled. The default value istrue.See Also:
-
© 2008, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from JavaFX API Documentation.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Java, JavaFX and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.