Package com.opentok

Enum Class Broadcast.StreamMode

java.lang.Object

java.lang.Enum<Broadcast.StreamMode>

com.opentok.Broadcast.StreamMode

All Implemented Interfaces:

Serializable, Comparable<Broadcast.StreamMode>, Constable

Enclosing class:

Broadcast

public static enum Broadcast.StreamMode
extends Enum<Broadcast.StreamMode>

Defines values used in the BroadcastProperties.Builder.streamMode(com.opentok.Broadcast.StreamMode) method and returned by the Broadcast.getStreamMode() method.

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
AUTO	Streams will be automatically included in the broadcast.
MANUAL	Streams will be included in the archive based on calls to the OpenTok.addBroadcastStream(String, String, boolean, boolean) and OpenTok.removeBroadcastStream(String, String) methods.

Method Summary

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

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

AUTO

public static final Broadcast.StreamMode AUTO

Streams will be automatically included in the broadcast.

MANUAL

public static final Broadcast.StreamMode MANUAL

Streams will be included in the archive based on calls to the OpenTok.addBroadcastStream(String, String, boolean, boolean) and OpenTok.removeBroadcastStream(String, String) methods.

Method Details

values

public static Broadcast.StreamMode[] 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 Broadcast.StreamMode 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

toString

public String toString()

Overrides:

toString in class Enum<Broadcast.StreamMode>