ISpeedControlVolume

​

Interface ISpeedControlVolume

interface ISpeedControlVolume

Extends com.amazon.apmf.IStandard Interface that encapsulates Speed Control Volume 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 object

---

​

getNumLevels()

i32 getNumLevels()

Get the number of supported volume levels

​

Returns

i32 number of volume levels supported

---

​

setLevel()

void setLevel(i32 level)

Set the speed control volume level

​

Parameters

level

i32 — Required volume level

---

​

getLevel()

i32 getLevel()

Get the current volume level

​

Returns

i32 current volume level

---

​

addSpeedControlVolumeListener()

com.amazon.apmf.ISubscription* addSpeedControlVolumeListener(ISpeedControlVolumeListener* callback)

Register listener for effect events

​

Parameters

callback

ISpeedControlVolumeListener* — Required event listener

​

Returns

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

---