Package: android.hardware.audio.effect@2.0

IVirtualizerEffect

interface IVirtualizerEffect extends IEffect

Properties

StrengthRange

enum StrengthRange: uint16_t
Details
Members
MIN = 0
MAX = 1000

SpeakerAngle

struct SpeakerAngle {AudioChannelMask mask; int16_t azimuth; int16_t elevation}
Details
Members
mask
azimuth
elevation

Methods

isStrengthSupported

isStrengthSupported ()
generates (bool strengthSupported)

Returns whether setting virtualization strength is supported.

Details
Generates
strengthSupported

setStrength

setStrength (uint16_t strength)
generates (Result retval)

Sets virtualization strength.

Details
Parameters
strength
strength of the effect.The valid range for strength strength is[0, 1000], where 0 per mille designates the mildest effect and 1000 per mille designates the strongest.
Generates
retval
operation completion status.

getStrength

getStrength ()
generates (Result retval, uint16_t strength)

Gets virtualization strength.

Details
Generates
retval
strength

getVirtualSpeakerAngles

getVirtualSpeakerAngles (AudioChannelMask mask, AudioDevice device)
generates (Result retval, vec<SpeakerAngle> speakerAngles)

Retrieves virtual speaker angles for the given channel mask on the specified device.

Details
Parameters
mask
device
Generates
retval
speakerAngles

forceVirtualizationMode

forceVirtualizationMode (AudioDevice device)
generates (Result retval)

Forces the virtualizer effect for the given output device.

Details
Parameters
device
Generates
retval

getVirtualizationMode

getVirtualizationMode ()
generates (Result retval, AudioDevice device)

Returns audio device reflecting the current virtualization mode, AUDIO_DEVICE_NONE when not virtualizing.

Details
Generates
retval
device