public interface

IEqualizer

implements IAudioEffect
com.h6ah4i.android.media.audiofx.IEqualizer
Known Indirect Subclasses

Summary

Nested Classes
interface IEqualizer.OnParameterChangeListener The OnParameterChangeListener interface defines a method called by the Equalizer when a parameter value has changed. 
class IEqualizer.Settings The Settings class regroups all equalizer parameters. 
Constants
int PARAM_BAND_FREQ_RANGE Band frequency range.
int PARAM_BAND_LEVEL Band level.
int PARAM_CENTER_FREQ Band center frequency.
int PARAM_CURRENT_PRESET Current preset.
int PARAM_GET_BAND Band for a given frequency.
int PARAM_GET_NUM_OF_PRESETS Request number of presets.
int PARAM_GET_PRESET_NAME Request preset name.
int PARAM_LEVEL_RANGE Band level range.
int PARAM_NUM_BANDS Number of bands.
int PARAM_STRING_SIZE_MAX Maximum size for preset name
short PRESET_UNDEFINED
[Expand]
Inherited Constants
From interface com.h6ah4i.android.media.audiofx.IAudioEffect
Public Methods
abstract short getBand(int frequency)
Gets the band that has the most effect on the given frequency.
abstract int[] getBandFreqRange(short band)
abstract short getBandLevel(short band)
Gets the gain set for the given equalizer band.
abstract short[] getBandLevelRange()
Gets the level range for use by setBandLevel(short, short).
abstract int getCenterFreq(short band)
Gets the center frequency of the given band.
abstract short getCurrentPreset()
Gets current preset.
abstract short getNumberOfBands()
Gets the number of frequency bands supported by the Equalizer engine.
abstract short getNumberOfPresets()
Gets the total number of presets the equalizer supports.
abstract String getPresetName(short preset)
Gets the preset name based on the index.
abstract IEqualizer.Settings getProperties()
Gets the equalizer properties.
abstract void setBandLevel(short band, short level)
Sets the given equalizer band to the given gain value.
abstract void setParameterListener(IEqualizer.OnParameterChangeListener listener)
Registers an OnParameterChangeListener interface.
abstract void setProperties(IEqualizer.Settings settings)
Sets the equalizer properties.
abstract void usePreset(short preset)
Sets the equalizer according to the given preset.
[Expand]
Inherited Methods
From interface com.h6ah4i.android.media.IReleasable
From interface com.h6ah4i.android.media.audiofx.IAudioEffect

Constants

public static final int PARAM_BAND_FREQ_RANGE

Band frequency range. Parameter ID for android.media.audiofx.Equalizer.OnParameterChangeListener

Constant Value: 4 (0x00000004)

public static final int PARAM_BAND_LEVEL

Band level. Parameter ID for OnParameterChangeListener

Constant Value: 2 (0x00000002)

public static final int PARAM_CENTER_FREQ

Band center frequency. Parameter ID for OnParameterChangeListener

Constant Value: 3 (0x00000003)

public static final int PARAM_CURRENT_PRESET

Current preset. Parameter ID for OnParameterChangeListener

Constant Value: 6 (0x00000006)

public static final int PARAM_GET_BAND

Band for a given frequency. Parameter ID for OnParameterChangeListener

Constant Value: 5 (0x00000005)

public static final int PARAM_GET_NUM_OF_PRESETS

Request number of presets. Parameter ID for OnParameterChangeListener

Constant Value: 7 (0x00000007)

public static final int PARAM_GET_PRESET_NAME

Request preset name. Parameter ID for OnParameterChangeListener

Constant Value: 8 (0x00000008)

public static final int PARAM_LEVEL_RANGE

Band level range. Parameter ID for OnParameterChangeListener

Constant Value: 0 (0x00000000)

public static final int PARAM_NUM_BANDS

Number of bands. Parameter ID for OnParameterChangeListener

Constant Value: 0 (0x00000000)

public static final int PARAM_STRING_SIZE_MAX

Maximum size for preset name

Constant Value: 32 (0x00000020)

public static final short PRESET_UNDEFINED

Constant Value: -1 (0xffffffff)

Public Methods

public abstract short getBand (int frequency)

Gets the band that has the most effect on the given frequency.

Parameters
frequency frequency in milliHertz which is to be equalized via the returned band.
Returns
  • the frequency band that has most effect on the given frequency.
Throws
IllegalStateException
IllegalArgumentException
UnsupportedOperationException
IllegalArgumentException
IllegalStateException

public abstract int[] getBandFreqRange (short band)

Throws
IllegalArgumentException
IllegalStateException
UnsupportedOperationException

public abstract short getBandLevel (short band)

Gets the gain set for the given equalizer band.

Parameters
band frequency band whose gain is requested. The numbering of the bands starts from 0 and ends at (number of bands - 1).
Returns
  • the gain in millibels of the given band.
Throws
IllegalStateException
IllegalArgumentException
UnsupportedOperationException
IllegalArgumentException
IllegalStateException

public abstract short[] getBandLevelRange ()

Gets the level range for use by setBandLevel(short, short). The level is expressed in milliBel.

Returns
  • the band level range in an array of short integers. The first element is the lower limit of the range, the second element the upper limit.
Throws
IllegalStateException
IllegalArgumentException
UnsupportedOperationException
IllegalArgumentException
IllegalStateException

public abstract int getCenterFreq (short band)

Gets the center frequency of the given band.

Parameters
band frequency band whose center frequency is requested. The numbering of the bands starts from 0 and ends at (number of bands - 1).
Returns
  • the center frequency in milliHertz
Throws
IllegalStateException
IllegalArgumentException
UnsupportedOperationException
IllegalArgumentException
IllegalStateException

public abstract short getCurrentPreset ()

Gets current preset.

Returns
  • the preset that is set at the moment.
Throws
IllegalStateException
IllegalArgumentException
UnsupportedOperationException
IllegalArgumentException
IllegalStateException

public abstract short getNumberOfBands ()

Gets the number of frequency bands supported by the Equalizer engine.

Returns
  • the number of bands
Throws
IllegalStateException
IllegalArgumentException
UnsupportedOperationException
IllegalArgumentException
IllegalStateException

public abstract short getNumberOfPresets ()

Gets the total number of presets the equalizer supports. The presets will have indices [0, number of presets-1].

Returns
  • the number of presets the equalizer supports.
Throws
IllegalStateException
IllegalArgumentException
UnsupportedOperationException
IllegalArgumentException
IllegalStateException

public abstract String getPresetName (short preset)

Gets the preset name based on the index.

Parameters
preset index of the preset. The valid range is [0, number of presets-1].
Returns
  • a string containing the name of the given preset.
Throws
IllegalStateException
IllegalArgumentException
UnsupportedOperationException
IllegalArgumentException
IllegalStateException

public abstract IEqualizer.Settings getProperties ()

Gets the equalizer properties. This method is useful when a snapshot of current equalizer settings must be saved by the application.

Returns
  • an IEqualizer.Settings object containing all current parameters values
Throws
IllegalStateException
IllegalArgumentException
UnsupportedOperationException
IllegalArgumentException
IllegalStateException

public abstract void setBandLevel (short band, short level)

Sets the given equalizer band to the given gain value.

Parameters
band frequency band that will have the new gain. The numbering of the bands starts from 0 and ends at (number of bands - 1).
level new gain in millibels that will be set to the given band. getBandLevelRange() will define the maximum and minimum values.
Throws
IllegalStateException
IllegalArgumentException
UnsupportedOperationException
IllegalArgumentException
IllegalStateException
UnsupportedOperationException
See Also

public abstract void setParameterListener (IEqualizer.OnParameterChangeListener listener)

Registers an OnParameterChangeListener interface.

Parameters
listener OnParameterChangeListener interface registered

public abstract void setProperties (IEqualizer.Settings settings)

Sets the equalizer properties. This method is useful when equalizer settings have to be applied from a previous backup.

Parameters
settings an IEqualizer.Settings object containing the properties to apply
Throws
IllegalStateException
IllegalArgumentException
UnsupportedOperationException
IllegalArgumentException
IllegalStateException

public abstract void usePreset (short preset)

Sets the equalizer according to the given preset.

Parameters
preset new preset that will be taken into use. The valid range is [0, number of presets-1].
Throws
IllegalStateException
IllegalArgumentException
UnsupportedOperationException
IllegalArgumentException
IllegalStateException
UnsupportedOperationException
See Also