IFadeBalance

​

Interface IFadeBalance

interface IFadeBalance

Extends com.amazon.apmf.IStandard Interface that encapsulates Fade/Balance 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 the effect description

​

Returns

EffectDescriptor* effect descriptor

---

​

getFadeLevelsRange()

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

Get supported Fade min and max levels

​

Parameters

min (out)

i32* — Required pointer to return min Fade level

max (out)

i32* — Required pointer to return max Fade level

---

​

setFadeLevel()

void setFadeLevel(i32 level)

Set the Fade level

​

Parameters

level

i32 — Required Fade level to set

---

​

getFadeLevel()

i32 getFadeLevel()

Get the number of supported Fade levels

​

Returns

i32 number of Fade levels supported

---

​

getBalanceLevelsRange()

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

Get supported Balance min and max levels

​

Parameters

min (out)

i32* — Required pointer to return min Balance level

max (out)

i32* — Required pointer to return max Balance level

---

​

setBalanceLevel()

void setBalanceLevel(i32 level)

Set the Balance level

​

Parameters

level

i32 — Required Balance level to set

---

​

getBalanceLevel()

i32 getBalanceLevel()

Get the number of supported Balance levels

​

Returns

i32 number of Balance levels supported

---

​

addFadeBalanceListener()

com.amazon.apmf.ISubscription* addFadeBalanceListener(IFadeBalanceListener* callback)

Register listener for effect callback events

​

Parameters

callback

IFadeBalanceListener* — Required event listener

​

Returns

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

---