ICustomEffect

​

Interface ICustomEffect

interface ICustomEffect

Extends com.amazon.apmf.IStandard Interface that encapsulates Custom Audio Effect

​

Methods

​

enable()

void enable()

Enable the effect

---

​

disable()

void disable()

Disable the effect

---

​

isEnabled()

bool isEnabled()

Get effect enabled status

​

Returns

bool true if custom effect is enabled, false otherwise

---

​

getDescriptor()

EffectDescriptor* getDescriptor()

Get effect description

​

Returns

EffectDescriptor* effect descriptor

---

​

processCommand()

i8[] processCommand(Command* command)

Process given command and return the response

​

Parameters

command

Command* — Required command to be sent to the effect module

​

Returns

i8[] response payload data from the effect module

---

​

addEventListener()

com.amazon.apmf.ISubscription* addEventListener(ICustomEffectListener* callback)

Register listener for custom effect events

​

Parameters

callback

ICustomEffectListener* — Required effect event listener

​

Returns

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

---