Package com.amazonaws.ivs.broadcast

Class StageAudioManager.EffectPreference<T>

java.lang.Object
com.amazonaws.ivs.broadcast.StageAudioManager.EffectPreference<T>
Type Parameters:
T - The type of audio effect (EchoCancellation or NoiseSuppression)
Enclosing class:
StageAudioManager
public static class StageAudioManager.EffectPreference<T> extends Object
Represents a preference for an audio effect with a fallback option.

This class encapsulates a preferred audio effect algorithm and a fallback algorithm to use when the preferred option is unavailable. The SDK will attempt to use the preferred algorithm first, and automatically fall back to the fallback algorithm if the preferred one cannot be applied due to device limitations or audio configuration.

The preferred and fallback algorithms must be different. Attempting to create an EffectPreference with identical preferred and fallback values will throw an IllegalArgumentException.

See Also:

  • Field Details

    • preferred

      public final T preferred

    • fallback

      public final T fallback

  • Constructor Details

    • EffectPreference

      public EffectPreference(@NonNull T preferred, @NonNull T fallback)
      Creates an audio effect preference with a fallback option.
      Parameters:
      preferred - The preferred audio effect algorithm to use
      fallback - The fallback algorithm to use if preferred is unavailable
      Throws:
      IllegalArgumentException - if preferred and fallback are the same
      NullPointerException - if preferred or fallback is null

  • Method Details