com.opentok.RenderStatus
All Implemented Interfaces:
: Serializable, Comparable<RenderStatus>, Constable
public enum RenderStatus extends Enum<RenderStatus>
Enum representing the status of a Render.
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
FAILED
An error occurred and the Experience Composer could not proceed.
STARTED
The Vonage Video API platform has successfully connected to the remote application server, and is publishing the web view to an OpenTok stream.
STARTING
The Vonage Video API platform is in the process of connecting to the remote application at the URL provided.
STOPPED
The Experience Composer has stopped.
Method Summary
All MethodsStatic MethodsInstance MethodsConcrete Methods
Modifier and Type
Method
Description
static RenderStatus
fromString(String status)
String
toString()
static RenderStatus
valueOf(String name)
Returns the enum constant of this class with the specified name.
static RenderStatus[]
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
STARTING
public static final RenderStatus STARTING
The Vonage Video API platform is in the process of connecting to the remote application at the URL provided. This is the initial state.
STARTED
public static final RenderStatus STARTED
The Vonage Video API platform has successfully connected to the remote application server, and is publishing the web view to an OpenTok stream.
STOPPED
public static final RenderStatus STOPPED
The Experience Composer has stopped.
FAILED
public static final RenderStatus FAILED
An error occurred and the Experience Composer could not proceed. It may occur at startup if the OpenTok server cannot connect to the remote application server or republish the stream. It may also occur at any point during the process due to an error in the Vonage Video API platform.
Method Details
values
public static RenderStatus[] 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 RenderStatus 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
fromString
public static RenderStatus fromString(String status)
toString
public String toString()
Overrides:
: toString in class Enum<RenderStatus>