com.opentok

Enum Broadcast.StreamMode

java.lang.Object

java.lang.Enum<Broadcast.StreamMode>

com.opentok.Broadcast.StreamMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Broadcast.StreamMode>

Enclosing class:

Broadcast

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

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

Enum Constant Summary

Enum Constants

Enum Constant and 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 and Description
java.lang.String	toString()
static Broadcast.StreamMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Broadcast.StreamMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

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 Detail

values

public static Broadcast.StreamMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Broadcast.StreamMode c : Broadcast.StreamMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Broadcast.StreamMode valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<Broadcast.StreamMode>