Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)

Summary: Fields | Ctors | Inherited Methods | [Expand All]

Added in API level 9

public static class

AudioEffect.Descriptor

extends Object

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

Class Overview

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

type: 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: UUID for this particular implementation
connectMode: EFFECT_INSERT or EFFECT_AUXILIARY
name: human readable effect name
implementor: human readable effect implementor name

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)

[Expand]

Inherited Methods

From class java.lang.Object

Object	clone () Creates and returns a copy of this `Object` .
boolean	equals ( Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize () Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class <?>	getClass () Returns the unique instance of `Class` that represents this object's class.
int	hashCode () Returns an integer hash code for this object.
final void	notify () Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll () Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString () Returns a string containing a concise, human-readable description of this object.
final void	wait () Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait (long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait (long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

Fields

public String connectMode

Added in API level 9

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 .

public String implementor

Added in API level 9

Human readable effect implementor name

public String name

Added in API level 9

Human readable effect name

public UUID type

Added in API level 9

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.

public UUID uuid

Added in API level 9

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

public AudioEffect.Descriptor ()

Added in API level 9

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

Added in API level 9

Parameters

type	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	UUID for this particular implementation
connectMode	`EFFECT_INSERT` or `EFFECT_AUXILIARY`
name	human readable effect name
implementor	human readable effect implementor name

Results

Interfaces

Classes

AudioEffect.Descriptor

Class Overview

Summary

Fields

public String connectMode

public String implementor

public String name

public UUID type

public UUID uuid

Public Constructors

public AudioEffect.Descriptor ()

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

Parameters