Package com.amazonaws.ivs.broadcast

Enum Class StageAudioManager.Usage

java.lang.Object

java.lang.Enum<StageAudioManager.Usage>

com.amazonaws.ivs.broadcast.StageAudioManager.Usage

All Implemented Interfaces:

Serializable, Comparable<StageAudioManager.Usage>, Constable

Enclosing class:

StageAudioManager

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

Audio usage types that describe the intended use of the audio output.

The usage attribute helps the platform make audio routing and volume decisions based on the purpose of the audio stream.

See AudioAttributes.getUsage() in the Android documentation for more details.

• GAME - Audio for game sound effects and music. See USAGE_GAME.
• MEDIA - General media playback audio. See USAGE_MEDIA.
• VOICE_COMMUNICATION - Audio for real-time voice communication, such as a voice or video call. See USAGE_VOICE_COMMUNICATION.

See Also:

• StageAudioManager.setConfiguration(Source, ContentType, Usage)
• StageAudioManager.UseCasePreset

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
GAME
MEDIA
VOICE_COMMUNICATION

Method Summary

Modifier and Type	Method	Description
static StageAudioManager.Usage	valueOf(String name)	Returns the enum constant of this class with the specified name.
static StageAudioManager.Usage[]	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

GAME

public static final StageAudioManager.Usage GAME

MEDIA

public static final StageAudioManager.Usage MEDIA

VOICE_COMMUNICATION

public static final StageAudioManager.Usage VOICE_COMMUNICATION

Method Details

values

public static StageAudioManager.Usage[] 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.Usage 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