IEqualizer

​

Interface IEqualizer

interface IEqualizer

Extends com.amazon.apmf.IStandard Interface that encapsulates Equalizer Effect

​

Methods

​

enable()

void enable()

Enable the effect

---

​

disable()

void disable()

Disable the effect

---

​

isEnabled()

bool isEnabled()

Get the effect enable status

​

Returns

bool true if effect is enabled, false otherwise

---

​

getDescriptor()

EffectDescriptor* getDescriptor()

Get the description of the effect

​

Returns

EffectDescriptor* Pointer to the effect descriptor

---

​

getNumBands()

i32 getNumBands()

​

Returns

i32 get the number of bands supported

---

​

getBandInfo()

EqualizerBandInfo getBandInfo(i32 band)

Get the equalizer info for the band index

​

Parameters

band

i32 — Required index into array of bands

​

Returns

EqualizerBandInfo band information of the requested band

---

​

setGain()

void setGain(i32 band, i32 gain)

Set the gain for band

​

Parameters

band

i32 — Required index into array of bands

gain

i32 — Required value for the band

---

​

getGain()

i32 getGain(i32 band)

Get the gain for band

​

Parameters

band

i32 — Required index into array of bands

​

Returns

i32 gain value for the band

---

​

getNumPresets()

i32 getNumPresets()

Get the number of presets supported

​

Returns

i32 number of presets supported by the effect

---

​

getPresetInfo()

EqualizerPresetInfo getPresetInfo(i32 preset)

Get the preset info for the preset index

​

Parameters

preset

i32 — Required index into array of presets

​

Returns

EqualizerPresetInfo preset information for the preset index

---

​

getSettings()

EqualizerSettings getSettings()

Get equalizer settings

​

Returns

EqualizerSettings equalizer settings

---

​

setPresetIndex()

void setPresetIndex(i32 preset)

Set the preset index

​

Parameters

preset

i32 — Required index into array of presets

---

​

getPresetIndex()

i32 getPresetIndex()

Get the preset index

​

Returns

i32 current preset index

---

​

addEqualizerListener()

com.amazon.apmf.ISubscription* addEqualizerListener(IEqualizerListener* callback)

Register listener for effect events

​

Parameters

callback

IEqualizerListener* — Required listener for effect events

​

Returns

com.amazon.apmf.ISubscription* ISubscription pointer to be used to unsubscribe to the listener

---