IAudioPatchBuilder

​

Interface IAudioPatchBuilder

interface IAudioPatchBuilder

Extends com.amazon.apmf.IStandard Interface for encapsulating the Audio Patch Builder

​

Methods

​

sourceType()

IAudioPatchBuilder* sourceType(AudioSource* sourceType)

Set audio source type

​

Parameters

sourceType

AudioSource* — Required type of audio patch source

​

Returns

IAudioPatchBuilder* pointer to patch builder object

---

​

sourceConfig()

IAudioPatchBuilder* sourceConfig(AudioConfig* audioConfig)

Set audio configuration to read audio data from the source device

​

Parameters

audioConfig

AudioConfig* — Required audio configuration of the patch source

​

Returns

IAudioPatchBuilder* pointer to patch builder object

---

​

sinkAttributes()

IAudioPatchBuilder* sinkAttributes(AudioAttributes* audioAttr)

Set audio attributes of the data to be played on the sink device

​

Parameters

audioAttr

AudioAttributes* — Required playback attributes for audio patch sink

​

Returns

IAudioPatchBuilder* pointer to patch builder object

---

​

focusSessionId()

IAudioPatchBuilder* focusSessionId(i32 focusSessionId)

Set audio focus session id

​

Parameters

focusSessionId

i32 — Required focus session id that the patch receives the focus events

​

Returns

IAudioPatchBuilder* pointer to patch builder object

---

​

sourceDevice()

IAudioPatchBuilder* sourceDevice(IAudioDevice* audioDevice)

Set audio source device If not set, the platform will determine the source device from source type

​

Parameters

audioDevice

IAudioDevice* — Required source device for the patch creation

​

Returns

IAudioPatchBuilder* pointer to patch builder object

---

​

sinkDevices()

IAudioPatchBuilder* sinkDevices(IAudioDevice*[] sinkDevices)

Set audio sink devices Optional. If the sink device is not supplied, the platform will determine the sink device based on the audio attributes and available sink devices.

​

Parameters

sinkDevices

IAudioDevice*[] — Required list of sink devices for the patch creation

​

Returns

IAudioPatchBuilder* pointer to patch builder object

---

​

build()

IAudioPatch* build()

Build audio patch object

​

Returns

IAudioPatch* pointer to created audio patch object

---