Package com.amazonaws.ivs.broadcast

Enum Class StageAudioManager.EchoCancellation

java.lang.Object

java.lang.Enum<StageAudioManager.EchoCancellation>

com.amazonaws.ivs.broadcast.StageAudioManager.EchoCancellation

All Implemented Interfaces:

Serializable, Comparable<StageAudioManager.EchoCancellation>, Constable

Enclosing class:

StageAudioManager

public static enum StageAudioManager.EchoCancellation
extends Enum<StageAudioManager.EchoCancellation>

Echo cancellation algorithms available for audio processing.

Echo cancellation removes the audio output (what the user hears) from the audio input (what the microphone captures), preventing feedback loops and echo in real-time communication.

When echo cancellation is required, the SDK recommends using PLATFORM_ACOUSTIC_ECHO_CANCELER as the preferred algorithm with AECM as fallback for best compatibility and performance across devices. This is the default configuration.

• PLATFORM_ACOUSTIC_ECHO_CANCELER - Uses the platform's built-in echo cancellation (Android AcousticEchoCanceler). Provides the best performance and quality when available. Requires Android API level 29+. The SDK will automatically fall back to the specified software algorithm if native echo cancellation is unavailable.
• AECM - Uses the AECM (Acoustic Echo Cancellation for Mobile) software implementation. A reliable fallback option for devices without native echo cancellation. Uses less CPU resources than AEC3. AECM will duck or silence the playback output to reduce echo.
• AEC3 - Uses the AEC3 (Acoustic Echo Cancellation 3) software implementation. AEC3 will perform wave analysis to remove the playback audio from the input stream to reduce echo.

See Also:

• StageAudioManager.setPreferredEchoCancellation(EffectPreference)
• StageAudioManager.enableEchoCancellation(boolean)

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AEC3
AECM
PLATFORM_ACOUSTIC_ECHO_CANCELER

Method Summary

Modifier and Type	Method	Description
static StageAudioManager.EchoCancellation	valueOf(String name)	Returns the enum constant of this class with the specified name.
static StageAudioManager.EchoCancellation[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PLATFORM_ACOUSTIC_ECHO_CANCELER

public static final StageAudioManager.EchoCancellation PLATFORM_ACOUSTIC_ECHO_CANCELER

AECM

public static final StageAudioManager.EchoCancellation AECM

AEC3

public static final StageAudioManager.EchoCancellation AEC3

Method Details

values

public static StageAudioManager.EchoCancellation[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static StageAudioManager.EchoCancellation valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null