Module uk.co.caprica.vlcj

Package uk.co.caprica.vlcj.factory

Class EqualizerApi

java.lang.Object

uk.co.caprica.vlcj.factory.EqualizerApi

public final class EqualizerApi
extends Object

Behaviour pertaining to the audio equalizer.

Method Summary

Modifier and Type	Method	Description
final Map<String,Equalizer>	allPresetEqualizers()	Get all of the available preset equalizer instances.
final List<Float>	bands()	Get the list of distinct equalizer band frequencies.
final Equalizer	newEqualizer()	Create a new audio equalizer.
final Equalizer	newEqualizer(String presetName)	Create a new audio equalizer from a named preset.
final List<String>	presets()	Get the list of names of available equalizer presets.

Methods inherited from class java.lang.Object

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

Method Details

bands

public final List<Float> bands()

Get the list of distinct equalizer band frequencies.

Returns:

list of frequencies (Hz)

presets

public final List<String> presets()

Get the list of names of available equalizer presets.

Returns:

list of preset names

newEqualizer

public final Equalizer newEqualizer()

Create a new audio equalizer.

Returns:

equalizer

newEqualizer

public final Equalizer newEqualizer(String presetName)

Create a new audio equalizer from a named preset.

Parameters:

presetName - name of the preset

Returns:

equalizer

allPresetEqualizers

public final Map<String,Equalizer> allPresetEqualizers()

Get all of the available preset equalizer instances.

This will return new equalizer instances (i.e. they are not cached or shared), so applications are free to change the values in the returned equalizer instances if so desired.

Returns:

map of preset name to equalizer instance, sorted by name