IBeamDirectionEffectBuilder

​

Interface IBeamDirectionEffectBuilder

interface IBeamDirectionEffectBuilder

Extends com.amazon.apmf.IStandard Interface that encapsulates Beam Direction Audio Effect Builder

​

Methods

​

sessionId()

IBeamDirectionEffectBuilder* sessionId(i32 sessionId)

Optional. If session id is not supplied, effect will be applied on active voice recognition streams. Alternatively, if there is platform support, client can pass in a session id to attach the effect to a specific record stream.

​

Parameters

sessionId

i32 — Required session ID to which record session the effect needs to be attached

​

Returns

IBeamDirectionEffectBuilder* effect builder object

---

​

effectDescriptor()

IBeamDirectionEffectBuilder* effectDescriptor(EffectDescriptor* effectDescriptor)

Set effect descriptor

​

Parameters

effectDescriptor

EffectDescriptor* — Required effect descriptor

​

Returns

IBeamDirectionEffectBuilder* effect builder object

---

​

build()

IBeamDirection* build()

Build Beam Direction audio effect object. Only privileged clients are allowed to create and attach Beam Direction effects to record streams. Needs privilege “com.amazon.audio.privilege.microphone.access”

​

Returns

IBeamDirection* effect object

---