Added in API level 9

Summary: Fields | Ctors | Methods | Inherited Methods

AudioEffect.Descriptor

Kotlin |Java

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:

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

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
`Descriptor()`
`Descriptor(String type, String uuid, String connectMode, String name, String implementor)`

Public methods
`boolean`	`equals(Object o)` Indicates whether some other object is "equal to" this one.
`int`	`hashCode()` Returns a hash code value for the object.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

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

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

Descriptor

Added in API level 9

public Descriptor ()

Descriptor

Added in API level 9

public 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`, `AudioEffect#EFFECT_TYPE_HAPTIC_GENERATOR`.
`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

Public methods

equals

Added in API level 9

public boolean equals (Object o)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
`o`	`Object`: the reference object with which to compare.

Returns
`boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

hashCode

Added in API level 9

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns
`int`	a hash code value for this object.