Package com.amazonaws.ivs.broadcast

Enum Class Stage.SubscribeState

java.lang.Object

java.lang.Enum<Stage.SubscribeState>

com.amazonaws.ivs.broadcast.Stage.SubscribeState

All Implemented Interfaces:

Serializable, Comparable<Stage.SubscribeState>, Constable

Enclosing class:

Stage

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

The various potential subscribe states for a participant

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
ATTEMPTING_SUBSCRIBE	An subscription is being established to the remote participant
NOT_SUBSCRIBED	The participant is not being subscribed to
SUBSCRIBED	There is a connected subscription to the remote participant

Method Summary

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

NOT_SUBSCRIBED

public static final Stage.SubscribeState NOT_SUBSCRIBED

The participant is not being subscribed to

ATTEMPTING_SUBSCRIBE

public static final Stage.SubscribeState ATTEMPTING_SUBSCRIBE

An subscription is being established to the remote participant

SUBSCRIBED

public static final Stage.SubscribeState SUBSCRIBED

There is a connected subscription to the remote participant

Method Details

values

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