Package com.amazonaws.ivs.broadcast

Enum Class Stage.SubscribeType

java.lang.Object

java.lang.Enum<Stage.SubscribeType>

com.amazonaws.ivs.broadcast.Stage.SubscribeType

All Implemented Interfaces:

Serializable, Comparable<Stage.SubscribeType>, Constable

Enclosing class:

Stage

public static enum Stage.SubscribeType
extends Enum<Stage.SubscribeType>

SubscribeType is used in Stage.Strategy to indicate whether SDK should subscribe and what media type it should subscribe

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
AUDIO_ONLY	Subscribe to pariticipant's audio
AUDIO_VIDEO	Subscribe to both pariticipant's audio and video
NONE	Do not subscribe to a participant.

Method Summary

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

NONE

public static final Stage.SubscribeType NONE

Do not subscribe to a participant.

AUDIO_ONLY

public static final Stage.SubscribeType AUDIO_ONLY

Subscribe to pariticipant's audio

AUDIO_VIDEO

public static final Stage.SubscribeType AUDIO_VIDEO

Subscribe to both pariticipant's audio and video

Method Details

values

public static Stage.SubscribeType[] 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 Stage.SubscribeType 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