added in API level 9

AudioEffect.Descriptor

public static class AudioEffect.Descriptor
extends Object

java.lang.Object
   ↳ android.media.audiofx.AudioEffect.Descriptor


The effect descriptor contains information on a particular effect implemented in the audio framework:

The method AudioEffect.queryEffects() returns an array of Descriptors to facilitate effects enumeration.

Summary

Fields

public String connectMode

Indicates if the effect is of insert category AudioEffect.EFFECT_INSERT or auxiliary category AudioEffect.EFFECT_AUXILIARY.

public String implementor

Human readable effect implementor name

public String name

Human readable effect name

public UUID type

Indicates the generic type of the effect (Equalizer, Bass boost ...).

public UUID uuid

Indicates the particular implementation of the effect in that type.

Public constructors

AudioEffect.Descriptor()
AudioEffect.Descriptor(String type, String uuid, String connectMode, String name, String implementor)

Inherited methods

Fields

connectMode

added in API level 9
public String connectMode

Indicates if the effect is of insert category AudioEffect.EFFECT_INSERT or auxiliary category AudioEffect.EFFECT_AUXILIARY. Insert effects (typically an Equalizer) are applied to the entire audio source and usually not shared by several sources. Auxiliary effects (typically a reverberator) are applied to part of the signal (wet) and the effect output is added to the original signal (dry). Audio pre processing are applied to audio captured on a particular AudioRecord.

implementor

added in API level 9
public String implementor

Human readable effect implementor name

name

added in API level 9
public String name

Human readable effect name

type

added in API level 9
public UUID type

Indicates the generic type of the effect (Equalizer, Bass boost ...). One of AudioEffect.EFFECT_TYPE_AEC, AudioEffect.EFFECT_TYPE_AGC, AudioEffect.EFFECT_TYPE_BASS_BOOST, AudioEffect.EFFECT_TYPE_ENV_REVERB, AudioEffect.EFFECT_TYPE_EQUALIZER, AudioEffect.EFFECT_TYPE_NS, AudioEffect.EFFECT_TYPE_PRESET_REVERB AudioEffect.EFFECT_TYPE_VIRTUALIZER or AudioEffect.EFFECT_TYPE_DYNAMICS_PROCESSING.
For reverberation, bass boost, EQ and virtualizer, the UUID corresponds to the OpenSL ES Interface ID.

uuid

added in API level 9
public UUID uuid

Indicates the particular implementation of the effect in that type. Several effects can have the same type but this uuid is unique to a given implementation.

Public constructors

AudioEffect.Descriptor

added in API level 9
public AudioEffect.Descriptor ()

AudioEffect.Descriptor

added in API level 9
public AudioEffect.Descriptor (String type, 
                String uuid, 
                String connectMode, 
                String name, 
                String implementor)

Parameters
type String: UUID identifying the effect type. May be one of: AudioEffect.EFFECT_TYPE_AEC, AudioEffect.EFFECT_TYPE_AGC, AudioEffect.EFFECT_TYPE_BASS_BOOST, AudioEffect.EFFECT_TYPE_ENV_REVERB, AudioEffect.EFFECT_TYPE_EQUALIZER, AudioEffect.EFFECT_TYPE_NS, AudioEffect.EFFECT_TYPE_PRESET_REVERB, AudioEffect.EFFECT_TYPE_VIRTUALIZER, AudioEffect.EFFECT_TYPE_DYNAMICS_PROCESSING.

uuid String: UUID for this particular implementation

connectMode String: AudioEffect.EFFECT_INSERT or AudioEffect.EFFECT_AUXILIARY

name String: human readable effect name

implementor String: human readable effect implementor name