# AuxEffectInfo

Artifact: [androidx.media3:media3-common](https://developer.android.com/jetpack/androidx/releases/media3) [View Source](https://cs.android.com/search?q=file:androidx/media3/common/AuxEffectInfo.java+class:androidx.media3.common.AuxEffectInfo)

*** ** * ** ***


```
@UnstableApi
public final class AuxEffectInfo
```

<br />

*** ** * ** ***

Represents auxiliary effect information, which can be used to attach an auxiliary effect to an underlying `https://developer.android.com/reference/android/media/AudioTrack.html`.

Auxiliary effects can only be applied if the application has the `
android.permission.MODIFY_AUDIO_SETTINGS` permission. Apps are responsible for retaining the associated audio effect instance and releasing it when it's no longer needed. See the documentation of `https://developer.android.com/reference/android/media/audiofx/AudioEffect.html` for more information.

## Summary

| ### Constants |
|---|---|
| `static final int` | `https://developer.android.com/reference/androidx/media3/common/AuxEffectInfo#NO_AUX_EFFECT_ID() = 0` Value for `https://developer.android.com/reference/androidx/media3/common/AuxEffectInfo#effectId()` representing no auxiliary effect. |

| ### Public fields |
|---|---|
| `final int` | `https://developer.android.com/reference/androidx/media3/common/AuxEffectInfo#effectId()` The identifier of the effect, or `https://developer.android.com/reference/androidx/media3/common/AuxEffectInfo#NO_AUX_EFFECT_ID()` if there is no effect. |
| `final float` | `https://developer.android.com/reference/androidx/media3/common/AuxEffectInfo#sendLevel()` The send level for the effect. |

| ### Public constructors |
|---|
| `https://developer.android.com/reference/androidx/media3/common/AuxEffectInfo#AuxEffectInfo(int,float)(int effectId, float sendLevel)` Creates an instance with the given effect identifier and send level. |

| ### Public methods |
|---|---|
| `boolean` | `https://developer.android.com/reference/androidx/media3/common/AuxEffectInfo#equals(java.lang.Object)(@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/java/lang/Object.html o)` |
| `int` | `https://developer.android.com/reference/androidx/media3/common/AuxEffectInfo#hashCode()()` |

## Constants

### NO_AUX_EFFECT_ID

```
public static final int NO_AUX_EFFECT_ID = 0
```

Value for `https://developer.android.com/reference/androidx/media3/common/AuxEffectInfo#effectId()` representing no auxiliary effect.

## Public fields

### effectId

```
public final int effectId
```

The identifier of the effect, or `https://developer.android.com/reference/androidx/media3/common/AuxEffectInfo#NO_AUX_EFFECT_ID()` if there is no effect.

| See also |
|---|---|
| `https://developer.android.com/reference/android/media/AudioTrack.html#attachAuxEffect(int)` |   |

### sendLevel

```
public final float sendLevel
```

The send level for the effect.

| See also |
|---|---|
| `https://developer.android.com/reference/android/media/AudioTrack.html#setAuxEffectSendLevel(float)` |   |

## Public constructors

### AuxEffectInfo

```
public AuxEffectInfo(int effectId, float sendLevel)
```

Creates an instance with the given effect identifier and send level.

| Parameters |
|---|---|
| `int effectId` | The effect identifier. This is the value returned by `https://developer.android.com/reference/android/media/audiofx/AudioEffect.html#getId()` on the effect, or `https://developer.android.com/reference/androidx/media3/common/AuxEffectInfo#NO_AUX_EFFECT_ID()` which represents no effect. This value is passed to `https://developer.android.com/reference/android/media/AudioTrack.html#attachAuxEffect(int)` on the underlying audio track. |
| `float sendLevel` | The send level for the effect, where 0 represents no effect and a value of 1 is full send. If `effectId` is not `https://developer.android.com/reference/androidx/media3/common/AuxEffectInfo#NO_AUX_EFFECT_ID()`, this value is passed to `https://developer.android.com/reference/android/media/AudioTrack.html#setAuxEffectSendLevel(float)` on the underlying audio track. |

## Public methods

### equals

```
public boolean equals(@Nullable Object o)
```

### hashCode

```
public int hashCode()
```