IBassMidTreble

​

Interface IBassMidTreble

interface IBassMidTreble

Extends com.amazon.apmf.IStandard Interface that encapsulates Bass/Mid/Treble Effect

​

Methods

​

enable()

void enable()

Enable the effect

---

​

disable()

void disable()

Disable the effect

---

​

isEnabled()

bool isEnabled()

Get the effect enabled status

​

Returns

bool true if effect is enabled, false otherwise

---

​

getDescriptor()

EffectDescriptor* getDescriptor()

Get effect description

​

Returns

EffectDescriptor* effect descriptor

---

​

addBassMidTrebleListener()

com.amazon.apmf.ISubscription* addBassMidTrebleListener(IBassMidTrebleListener* callback)

Register listener for effect events

​

Parameters

callback

IBassMidTrebleListener* — Required effect event listener

​

Returns

com.amazon.apmf.ISubscription* pointer to effect event listener subscription

---

​

setBassBandLevel()

void setBassBandLevel(i32 level)

Set the bass band level

​

Parameters

level

i32 — Required bass band level to set

---

​

setMidBandLevel()

void setMidBandLevel(i32 level)

Set the mid range band level

​

Parameters

level

i32 — Required mid band level to set

---

​

setTrebleBandLevel()

void setTrebleBandLevel(i32 level)

Set the treble band level

​

Parameters

level

i32 — Required treble band level to set

---

​

setBandLevels()

void setBandLevels(i32 bass, i32 Mid, i32 treble)

Set the bass, mid, treble band levels

​

Parameters

bass

i32 — Required level

Mid

i32 — Required level

treble

i32 — Required level

---

​

isSubBandSupported()

bool isSubBandSupported()

Get if sub band is supported by the effect module

​

Returns

bool true if sub band is supported, false otherwise

---

​

setSubBandLevel()

void setSubBandLevel(i32 level)

Set the sub band level

​

Parameters

level

i32 — Required sub band level to set

---

​

getSubBandLevel()

i32 getSubBandLevel()

Get the sub band level

​

Returns

i32 current sub band level

---

​

getBassBandLevel()

i32 getBassBandLevel()

Get the bass band level

​

Returns

i32 current bass band level

---

​

getMidBandLevel()

i32 getMidBandLevel()

Get the mid band level

​

Returns

i32 current mid band level

---

​

getTrebleBandLevel()

i32 getTrebleBandLevel()

Get the treble band level

​

Returns

i32 current treble band level

---

​

getBandLevels()

void getBandLevels(out i32* bass, out i32* Mid, out i32* treble)

Get the current bass/mid/treble band levels

​

Parameters

bass (out)

i32* — Required pointer to return bass band level

Mid (out)

i32* — Required pointer to return mid band level

treble (out)

i32* — Required pointer to return treble band level

---

​

getBandLevelsRange()

void getBandLevelsRange(out i32* min, out i32* max)

Get the band levels range for effect

​

Parameters

min (out)

i32* — Required pointer to return min level supported

max (out)

i32* — Required pointer to return max level supported

---