ContextQMD
Back to Exoplayer

AuxEffectInfo (ExoPlayer library)

docs/doc/reference/com/google/android/exoplayer2/audio/AuxEffectInfo.html

latest5.1 KB
Original Source

Package com.google.android.exoplayer2.audio

Class AuxEffectInfo

[@Deprecated](https://developer.android.com/reference/java/lang/Deprecated.html "class or interface in java.lang")public final classAuxEffectInfoextends[Object](https://developer.android.com/reference/java/lang/Object.html "class or interface in java.lang")

Deprecated. com.google.android.exoplayer2 is deprecated. Please migrate to androidx.media3 (which contains the same ExoPlayer code). See the migration guide for more details, including a script to help with the migration.

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.

Field Summary

Fields | Modifier and Type | Field | Description | | --- | --- | --- | | int | effectId | Deprecated.

The identifier of the effect, or NO_AUX_EFFECT_ID if there is no effect. | | static int | NO_AUX_EFFECT_ID | Deprecated.

Value for effectId representing no auxiliary effect. | | float | sendLevel | Deprecated.

The send level for the effect. |

Constructor Summary

Constructors | Constructor | Description | | --- | --- | | AuxEffectInfo​(int effectId, float sendLevel) | Deprecated.

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

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods | Modifier and Type | Method | Description | | --- | --- | --- | | boolean | equals​(Object o) | Deprecated. | | int | hashCode() | Deprecated. |

-

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

-

NO_AUX_EFFECT_ID

public static final int NO_AUX_EFFECT_ID

Deprecated.

Value for effectId representing no auxiliary effect. See Also:Constant Field Values

-

effectId

public final int effectId

Deprecated.

The identifier of the effect, or NO_AUX_EFFECT_ID if there is no effect. See Also:AudioTrack.attachAuxEffect(int)

-

sendLevel

public final float sendLevel

Deprecated.

The send level for the effect. See Also:AudioTrack.setAuxEffectSendLevel(float)

Constructor Detail

-

AuxEffectInfo

public AuxEffectInfo​(int effectId,
                     float sendLevel)

Deprecated.

Creates an instance with the given effect identifier and send level. Parameters:effectId - The effect identifier. This is the value returned by AudioEffect.getId() on the effect, or NO_AUX_EFFECT_ID which represents no effect. This value is passed to AudioTrack.attachAuxEffect(int) on the underlying audio track.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 AudioTrack.setAuxEffectSendLevel(float) on the underlying audio track.

Method Detail

-

equals

public boolean equals​(@Nullable[Object](https://developer.android.com/reference/java/lang/Object.html "class or interface in java.lang")o)

Deprecated. Overrides:equals in class Object

-

hashCode

public int hashCode()

Deprecated. Overrides:hashCode in class Object