Skip to content

Most visited

Recently visited

navigation
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 queryEffects() returns an array of Descriptors to facilitate effects enumeration.

Summary

Fields

public String connectMode

Indicates if the effect is of insert category EFFECT_INSERT or auxiliary category 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

From class java.lang.Object

Fields

connectMode

Added in API level 9
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.

implementor

Added in API level 9
String implementor

Human readable effect implementor name

name

Added in API level 9
String name

Human readable effect name

type

Added in API level 9
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

Added in API level 9
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
AudioEffect.Descriptor ()

AudioEffect.Descriptor

Added in API level 9
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
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.