IPlaybackIntensityEffectBuilder

​

Interface IPlaybackIntensityEffectBuilder

interface IPlaybackIntensityEffectBuilder

Extends com.amazon.apmf.IStandard Interface that encapsulates Playback Output Intensity Builder

​

Methods

​

usageType()

IPlaybackIntensityEffectBuilder* usageType(AudioUsage* usage)

Set usage type of streams that the effect will observe and calculate RMS values from.

​

Parameters

usage

AudioUsage* — Required

​

Returns

IPlaybackIntensityEffectBuilder* pointer to effect builder object

---

​

effectDescriptor()

IPlaybackIntensityEffectBuilder* effectDescriptor(EffectDescriptor* effectDescriptor)

Set effect descriptor Optional. Only useful when the platform supports playback intensity effect from two different vendors. It allows to specify the vendor uuid in the effect descriptor to use corresponding implementation. If not specified, the OS will pick up the default effect implementation.

​

Parameters

effectDescriptor

EffectDescriptor* — Required pointer to the effect descriptor

​

Returns

IPlaybackIntensityEffectBuilder* pointer to effect builder object

---

​

playbackIntensitySettings()

IPlaybackIntensityEffectBuilder* playbackIntensitySettings(PlaybackIntensitySettings* settings)

Set playback intensity algorithm settings Optional. If this api not called, the effect will apply default settings. Client can query the applied settings using getPlaybackIntensitySettings api.

​

Parameters

settings

PlaybackIntensitySettings* — Required to be used by th algorithm

​

Returns

IPlaybackIntensityEffectBuilder* pointer to the effect builder object

---

​

build()

IPlaybackIntensity* build()

Build PlaybackIntensity effect object

​

Returns

IPlaybackIntensity* pointer to the effect object

​

Throws

• InvalidArgumentError — if the specified settings are not supported
• InvalidOperationError — if the platform does not support the effect

---