AuxEffectInfo

Kotlin |Java

@UnstableApi
class AuxEffectInfo

Represents auxiliary effect information, which can be used to attach an auxiliary effect to an underlying AudioTrack.

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 for more information.

Summary

Constants
`const Int`	`NO_AUX_EFFECT_ID = 0` Value for `effectId` representing no auxiliary effect.

Public constructors
`AuxEffectInfo(effectId: Int, sendLevel: Float)` Creates an instance with the given effect identifier and send level.

Public functions
`Boolean`	`equals(o: Any?)`
`Int`	`hashCode()`

Public properties
`Int`	`effectId` The identifier of the effect, or `NO_AUX_EFFECT_ID` if there is no effect.
`Float`	`sendLevel` The send level for the effect.

Constants

NO_AUX_EFFECT_ID

const val NO_AUX_EFFECT_ID = 0: Int

Value for 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`	The effect identifier. This is the value returned by `getId` on the effect, or `NO_AUX_EFFECT_ID` which represents no effect. This value is passed to `attachAuxEffect` on the underlying audio track.
`sendLevel: Float`	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`, this value is passed to `setAuxEffectSendLevel` 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 if there is no effect.

See also
`attachAuxEffect`

sendLevel

val sendLevel: Float

The send level for the effect.

See also
`setAuxEffectSendLevel`