AuxEffectInfo

@UnstableApi
public final 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
static final int

Value for effectId representing no auxiliary effect.

Public fields
final int

The identifier of the effect, or NO_AUX_EFFECT_ID if there is no effect.
final float

The send level for the effect.

Public constructors
AuxEffectInfo(int effectId, float sendLevel)

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

Public methods
boolean
int

Constants

NO_AUX_EFFECT_ID

public static final int NO_AUX_EFFECT_ID = 0

Value for effectId representing no auxiliary effect.

Public fields

effectId

public final int effectId

The identifier of the effect, or NO_AUX_EFFECT_ID if there is no effect.

See also
attachAuxEffect

sendLevel

public final float sendLevel

The send level for the effect.

See also
setAuxEffectSendLevel

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 getId on the effect, or NO_AUX_EFFECT_ID which represents no effect. This value is passed to attachAuxEffect 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 NO_AUX_EFFECT_ID, this value is passed to setAuxEffectSendLevel on the underlying audio track.

Public methods

equals

public boolean equals(@Nullable Object o)

hashCode

public int hashCode()