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:
EFFECT_TYPE_AEC
, EFFECT_TYPE_AGC
, EFFECT_TYPE_BASS_BOOST
, EFFECT_TYPE_ENV_REVERB
, EFFECT_TYPE_EQUALIZER
, EFFECT_TYPE_NS
, EFFECT_TYPE_PRESET_REVERB
, EFFECT_TYPE_VIRTUALIZER
. EFFECT_INSERT
or EFFECT_AUXILIARY
queryEffects()
returns an array of Descriptors to facilitate effects enumeration.
Fields |
|
---|---|
public String |
connectMode Indicates if the effect is of insert category |
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 |
|
---|---|
![]() java.lang.Object
|
String connectMode
Indicates if the effect is of insert category EFFECT_INSERT
or auxiliary category 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
.
UUID type
Indicates the generic type of the effect (Equalizer, Bass boost ...). One of EFFECT_TYPE_AEC
, EFFECT_TYPE_AGC
, EFFECT_TYPE_BASS_BOOST
, EFFECT_TYPE_ENV_REVERB
, EFFECT_TYPE_EQUALIZER
, EFFECT_TYPE_NS
, EFFECT_TYPE_PRESET_REVERB
or EFFECT_TYPE_VIRTUALIZER
.
For reverberation, bass boost, EQ and virtualizer, the UUID corresponds to the OpenSL ES Interface ID.
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.
AudioEffect.Descriptor (String type, String uuid, String connectMode, String name, String implementor)
Parameters | |
---|---|
type |
String : UUID identifying the effect type. May be one of: EFFECT_TYPE_AEC , EFFECT_TYPE_AGC , EFFECT_TYPE_BASS_BOOST , EFFECT_TYPE_ENV_REVERB , EFFECT_TYPE_EQUALIZER , EFFECT_TYPE_NS , EFFECT_TYPE_PRESET_REVERB , EFFECT_TYPE_VIRTUALIZER . |
uuid |
String : UUID for this particular implementation |
connectMode |
String : EFFECT_INSERT or EFFECT_AUXILIARY |
name |
String : human readable effect name |
implementor |
String : human readable effect implementor name |