ISpeechIntensity

​

Interface ISpeechIntensity

interface ISpeechIntensity

Extends com.amazon.apmf.IStandard

​

Methods

​

getDescriptor()

EffectDescriptor* getDescriptor()

Get the effect descriptor

​

Returns

EffectDescriptor* pointer to the effect descriptor of the effect object created

---

​

enable()

void enable()

Enable the effect Effect module will start processing the incoming audio data from the recording use case only after the effect is enabled.

---

​

disable()

void disable()

Disable the effect When disabled, the effect module will bypass processing the incoming audio data from the audio recording use case.

---

​

isEnabled()

bool isEnabled()

Get the enabled status

​

Returns

bool true if effect is enabled, false otherwise

---

​

getSpeechIntensitySettings()

SpeechIntensitySettings getSpeechIntensitySettings()

Get speech intensity algorithm settings

​

Returns

SpeechIntensitySettings current settings

---

​

getNormalizedSpeechIntensity()

float getNormalizedSpeechIntensity()

Get the computed intensity of the on-going stream Client is expected to call this periodically, frameSizeMs, in the settings queried using getSpeechIntensitySettings() api. If the client repeats the call earlier than the frameSizeMs, the effect will return value computed from previous frame data.

​

Returns

float normalized speech intensity value within the range 0.0 to 1.0f

​

Throws

• InvalidOperationError — if the effect is not enabled OR called after receiving the onSpeechProcessingStop callback event.

---

​

addListener()

com.amazon.apmf.ISubscription* addListener(ISpeechIntensityListener* listener)

Register listener for speech intensity events

​

Parameters

listener

ISpeechIntensityListener* — Required pointer to listener interface

​

Returns

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

​

Throws

• NullPointerError — if the callback pointer is null

---