Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Fields](https://developer.android.com/reference/android/media/audiofx/AudioEffect.Descriptor#lfields) \| [Ctors](https://developer.android.com/reference/android/media/audiofx/AudioEffect.Descriptor#pubctors) \| [Methods](https://developer.android.com/reference/android/media/audiofx/AudioEffect.Descriptor#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/media/audiofx/AudioEffect.Descriptor#inhmethods)

# AudioEffect.Descriptor

*** ** * ** ***

` public static class AudioEffect.Descriptor `   
` extends https://developer.android.com/reference/java/lang/Object ` ` `

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.media.audiofx.AudioEffect.Descriptor |

<br />

*** ** * ** ***

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

- type: UUID identifying the effect type. May be one of: `https://developer.android.com/reference/android/media/audiofx/AudioEffect#EFFECT_TYPE_AEC`, `https://developer.android.com/reference/android/media/audiofx/AudioEffect#EFFECT_TYPE_AGC`, `https://developer.android.com/reference/android/media/audiofx/AudioEffect#EFFECT_TYPE_BASS_BOOST`, `https://developer.android.com/reference/android/media/audiofx/AudioEffect#EFFECT_TYPE_ENV_REVERB`, `https://developer.android.com/reference/android/media/audiofx/AudioEffect#EFFECT_TYPE_EQUALIZER`, `https://developer.android.com/reference/android/media/audiofx/AudioEffect#EFFECT_TYPE_NS`, `https://developer.android.com/reference/android/media/audiofx/AudioEffect#EFFECT_TYPE_PRESET_REVERB`, `https://developer.android.com/reference/android/media/audiofx/AudioEffect#EFFECT_TYPE_VIRTUALIZER`, `https://developer.android.com/reference/android/media/audiofx/AudioEffect#EFFECT_TYPE_DYNAMICS_PROCESSING`, `https://developer.android.com/reference/android/media/audiofx/AudioEffect#EFFECT_TYPE_HAPTIC_GENERATOR`.
- uuid: UUID for this particular implementation
- connectMode: `https://developer.android.com/reference/android/media/audiofx/AudioEffect#EFFECT_INSERT` or `https://developer.android.com/reference/android/media/audiofx/AudioEffect#EFFECT_AUXILIARY`
- name: human readable effect name
- implementor: human readable effect implementor name

The method `https://developer.android.com/reference/android/media/audiofx/AudioEffect#queryEffects()` returns an array of Descriptors to facilitate effects enumeration.

<br />

## Summary

| ### Fields ||
|---|---|
| ` public https://developer.android.com/reference/java/lang/String` | `https://developer.android.com/reference/android/media/audiofx/AudioEffect.Descriptor#connectMode` Indicates if the effect is of insert category `https://developer.android.com/reference/android/media/audiofx/AudioEffect#EFFECT_INSERT` or auxiliary category `https://developer.android.com/reference/android/media/audiofx/AudioEffect#EFFECT_AUXILIARY`. |
| ` public https://developer.android.com/reference/java/lang/String` | `https://developer.android.com/reference/android/media/audiofx/AudioEffect.Descriptor#implementor` Human readable effect implementor name |
| ` public https://developer.android.com/reference/java/lang/String` | `https://developer.android.com/reference/android/media/audiofx/AudioEffect.Descriptor#name` Human readable effect name |
| ` public https://developer.android.com/reference/java/util/UUID` | `https://developer.android.com/reference/android/media/audiofx/AudioEffect.Descriptor#type` Indicates the generic type of the effect (Equalizer, Bass boost ...). |
| ` public https://developer.android.com/reference/java/util/UUID` | `https://developer.android.com/reference/android/media/audiofx/AudioEffect.Descriptor#uuid` Indicates the particular implementation of the effect in that type. |

| ### Public constructors ||
|---|---|
| ` https://developer.android.com/reference/android/media/audiofx/AudioEffect.Descriptor#Descriptor()() ` |
| ` https://developer.android.com/reference/android/media/audiofx/AudioEffect.Descriptor#Descriptor(java.lang.String,%20java.lang.String,%20java.lang.String,%20java.lang.String,%20java.lang.String)(https://developer.android.com/reference/java/lang/String type, https://developer.android.com/reference/java/lang/String uuid, https://developer.android.com/reference/java/lang/String connectMode, https://developer.android.com/reference/java/lang/String name, https://developer.android.com/reference/java/lang/String implementor) ` |

| ### Public methods ||
|---|---|
| ` boolean` | ` https://developer.android.com/reference/android/media/audiofx/AudioEffect.Descriptor#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object o) ` Indicates whether some other object is "equal to" this one. |
| ` int` | ` https://developer.android.com/reference/android/media/audiofx/AudioEffect.Descriptor#hashCode()() ` Returns a hash code value for the object. |

### Inherited methods

From class ` https://developer.android.com/reference/java/lang/Object ` ` https://developer.android.com/reference/java/lang/Object` ` https://developer.android.com/reference/java/lang/Object#clone()() `

Creates and returns a copy of this object.
` boolean` ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) `

Indicates whether some other object is "equal to" this one.
` void` ` https://developer.android.com/reference/java/lang/Object#finalize()() `

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
` final https://developer.android.com/reference/java/lang/Class<?>` ` https://developer.android.com/reference/java/lang/Object#getClass()() `

Returns the runtime class of this `Object`.
` int` ` https://developer.android.com/reference/java/lang/Object#hashCode()() `

Returns a hash code value for the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#notify()() `

Wakes up a single thread that is waiting on this object's monitor.
` final void` ` https://developer.android.com/reference/java/lang/Object#notifyAll()() `

Wakes up all threads that are waiting on this object's monitor.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/lang/Object#toString()() `

Returns a string representation of the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(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` ` https://developer.android.com/reference/java/lang/Object#wait(long)(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` ` https://developer.android.com/reference/java/lang/Object#wait()() `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*.

## Fields

### connectMode

Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String connectMode
```

Indicates if the effect is of insert category `https://developer.android.com/reference/android/media/audiofx/AudioEffect#EFFECT_INSERT` or auxiliary category `https://developer.android.com/reference/android/media/audiofx/AudioEffect#EFFECT_AUXILIARY`. Insert effects (typically an `https://developer.android.com/reference/android/media/audiofx/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 `https://developer.android.com/reference/android/media/AudioRecord`.

<br />

### implementor

Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String implementor
```

Human readable effect implementor name

<br />

### name

Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String name
```

Human readable effect name

<br />

### type

Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public UUID type
```

Indicates the generic type of the effect (Equalizer, Bass boost ...). One of `https://developer.android.com/reference/android/media/audiofx/AudioEffect#EFFECT_TYPE_AEC`, `https://developer.android.com/reference/android/media/audiofx/AudioEffect#EFFECT_TYPE_AGC`, `https://developer.android.com/reference/android/media/audiofx/AudioEffect#EFFECT_TYPE_BASS_BOOST`, `https://developer.android.com/reference/android/media/audiofx/AudioEffect#EFFECT_TYPE_ENV_REVERB`, `https://developer.android.com/reference/android/media/audiofx/AudioEffect#EFFECT_TYPE_EQUALIZER`, `https://developer.android.com/reference/android/media/audiofx/AudioEffect#EFFECT_TYPE_NS`, `https://developer.android.com/reference/android/media/audiofx/AudioEffect#EFFECT_TYPE_PRESET_REVERB` `https://developer.android.com/reference/android/media/audiofx/AudioEffect#EFFECT_TYPE_VIRTUALIZER`, `https://developer.android.com/reference/android/media/audiofx/AudioEffect#EFFECT_TYPE_DYNAMICS_PROCESSING`, or `https://developer.android.com/reference/android/media/audiofx/AudioEffect#EFFECT_TYPE_HAPTIC_GENERATOR`.  

For reverberation, bass boost, EQ and virtualizer, the UUID corresponds to the OpenSL ES Interface ID.

<br />

### uuid

Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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.

<br />

## Public constructors

### Descriptor

Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public Descriptor ()
```

<br />

<br />

### Descriptor

Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public Descriptor (String type, 
                String uuid, 
                String connectMode, 
                String name, 
                String implementor)
```

<br />

<br />

| Parameters ||
|---|---|
| `type` | `String`: UUID identifying the effect type. May be one of: `https://developer.android.com/reference/android/media/audiofx/AudioEffect#EFFECT_TYPE_AEC`, `https://developer.android.com/reference/android/media/audiofx/AudioEffect#EFFECT_TYPE_AGC`, `https://developer.android.com/reference/android/media/audiofx/AudioEffect#EFFECT_TYPE_BASS_BOOST`, `https://developer.android.com/reference/android/media/audiofx/AudioEffect#EFFECT_TYPE_ENV_REVERB`, `https://developer.android.com/reference/android/media/audiofx/AudioEffect#EFFECT_TYPE_EQUALIZER`, `https://developer.android.com/reference/android/media/audiofx/AudioEffect#EFFECT_TYPE_NS`, `https://developer.android.com/reference/android/media/audiofx/AudioEffect#EFFECT_TYPE_PRESET_REVERB`, `https://developer.android.com/reference/android/media/audiofx/AudioEffect#EFFECT_TYPE_VIRTUALIZER`, `https://developer.android.com/reference/android/media/audiofx/AudioEffect#EFFECT_TYPE_DYNAMICS_PROCESSING`, `https://developer.android.com/reference/android/media/audiofx/AudioEffect#EFFECT_TYPE_HAPTIC_GENERATOR`. <br /> |
| `uuid` | `String`: UUID for this particular implementation <br /> |
| `connectMode` | `String`: `https://developer.android.com/reference/android/media/audiofx/AudioEffect#EFFECT_INSERT` or `https://developer.android.com/reference/android/media/audiofx/AudioEffect#EFFECT_AUXILIARY` <br /> |
| `name` | `String`: human readable effect name <br /> |
| `implementor` | `String`: human readable effect implementor name <br /> |

## Public methods

### equals

Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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.

<br />

| Parameters ||
|---|---|
| `o` | `Object`: the reference object with which to compare. <br /> |

| Returns ||
|---|---|
| `boolean` | `true` if this object is the same as the obj argument; `false` otherwise. <br /> |

### hashCode

Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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 `https://developer.android.com/reference/java/util/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 `https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)` 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 `https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)` 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.

<br />

<br />

| Returns ||
|---|---|
| `int` | a hash code value for this object. <br /> |