Package: android.hardware.audio.effect@2.0

IEffectsFactory

interface IEffectsFactory

Methods

getAllDescriptors

getAllDescriptors ()
generates (Result retval, vec<EffectDescriptor> result)

Returns descriptors of different effects in all loaded libraries.

Details
Generates
retval
operation completion status.
result
list of effect descriptors.

getDescriptor

getDescriptor (Uuid uid)
generates (Result retval, EffectDescriptor result)

Returns a descriptor of a particular effect.

Details
Parameters
uid
Generates
retval
operation completion status.
result
effect descriptor.

createEffect

createEffect (Uuid uid, AudioSession session, AudioIoHandle ioHandle)
generates (Result retval, IEffect result, uint64_t effectId)

Creates an effect engine of the specified type.To release the effect engine, it is necessary to release references to the returned effect object.

Details
Parameters
uid
effect uuid.
session
audio session to which this effect instance will be attached.All effects created with the same session ID are connected in series and process the same signal stream.
ioHandle
identifies the output or input stream this effect is directed to in audio HAL.
Generates
retval
operation completion status.
result
the interface for the created effect.
effectId
the unique ID of the effect to be used with IStream::addEffect and IStream::removeEffect methods.

debugDump

debugDump (handle fd)

Dumps information about effects into the provided file descriptor.This is used for the dumpsys facility.

Details
Parameters
fd
dump file descriptor.