# AuxEffectInfo

# 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)

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/androidx/media3/common/AuxEffectInfo "View this page in Java")

<br />

```
@UnstableApi
class AuxEffectInfo
```

<br />

*** ** * ** ***

Represents auxiliary effect information, which can be used to attach an auxiliary effect to an underlying[AudioTrack](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[AudioEffect](https://developer.android.com/reference/android/media/audiofx/AudioEffect.html)for more information.

## Summary

|                                    ### Constants                                    |
|-------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `const `[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html) | [NO_AUX_EFFECT_ID](https://developer.android.com/reference/kotlin/androidx/media3/common/AuxEffectInfo#NO_AUX_EFFECT_ID())` = 0` Value for[effectId](https://developer.android.com/reference/kotlin/androidx/media3/common/AuxEffectInfo#effectId())representing no auxiliary effect. |

|                                                                                                                                                                                   ### Public constructors                                                                                                                                                                                   |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [AuxEffectInfo](https://developer.android.com/reference/kotlin/androidx/media3/common/AuxEffectInfo#AuxEffectInfo(int,float))`(effectId: `[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)`, sendLevel: `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)`)` Creates an instance with the given effect identifier and send level. |

|                                ### Public functions                                 |
|-------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) | [equals](https://developer.android.com/reference/kotlin/androidx/media3/common/AuxEffectInfo#equals(java.lang.Object))`(o: `[Any](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html)`?)` |
| [Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)         | [hashCode](https://developer.android.com/reference/kotlin/androidx/media3/common/AuxEffectInfo#hashCode())`()`                                                                                              |

|                              ### Public properties                              |
|---------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)     | [effectId](https://developer.android.com/reference/kotlin/androidx/media3/common/AuxEffectInfo#effectId()) The identifier of the effect, or[NO_AUX_EFFECT_ID](https://developer.android.com/reference/kotlin/androidx/media3/common/AuxEffectInfo#NO_AUX_EFFECT_ID())if there is no effect. |
| [Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html) | [sendLevel](https://developer.android.com/reference/kotlin/androidx/media3/common/AuxEffectInfo#sendLevel()) The send level for the effect.                                                                                                                                                 |

## Constants

### NO_AUX_EFFECT_ID

```
const val NO_AUX_EFFECT_ID = 0: Int
```

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

## Public constructors

### AuxEffectInfo

```
AuxEffectInfo(effectId: Int, sendLevel: Float)
```

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

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

## Public functions

### equals

```
fun equals(o: Any?): Boolean
```  

### hashCode

```
fun hashCode(): Int
```  

## Public properties

### effectId

```
val effectId: Int
```

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

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

### sendLevel

```
val sendLevel: Float
```

The send level for the effect.  

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