java.lang.Enum<Archive.Status>
com.opentok.Archive.Status
All Implemented Interfaces:
: Serializable, Comparable<Archive.Status>, Constable
Enclosing class: : Archive
public static enum Archive.Status extends Enum<Archive.Status>
Defines values returned by the Archive.getStatus() 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
AVAILABLE
The archive file is available for download from the OpenTok cloud.
DELETED
The archive file has been deleted.
EXPIRED
The archive file is no longer available at the OpenTok cloud.
FAILED
The recording of the archive failed.
PAUSED
The archive is in progress and no clients are publishing streams to the session.
STARTED
The archive recording has started and is in progress.
STOPPED
The archive recording has stopped, but the file is not available.
UPLOADED
The archive is available for download from the the upload target Amazon S3 bucket or Windows Azure container you set up for your OpenTok project.
Method Summary
All MethodsStatic MethodsInstance MethodsConcrete Methods
Modifier and Type
Method
Description
String
toString()
static Archive.Status
valueOf(String name)
Returns the enum constant of this class with the specified name.
static Archive.Status[]
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
AVAILABLE
public static final Archive.Status AVAILABLE
The archive file is available for download from the OpenTok cloud. You can get the URL of
the download file by calling the Archive.getUrl() method.
DELETED
public static final Archive.Status DELETED
The archive file has been deleted.
FAILED
public static final Archive.Status FAILED
The recording of the archive failed.
PAUSED
public static final Archive.Status PAUSED
The archive is in progress and no clients are publishing streams to the session. When an archive is in progress and any client publishes a stream, the status is STARTED. When an archive is PAUSED, nothing is recorded. When a client starts publishing a stream, the recording starts (or resumes). If all clients disconnect from a session that is being archived, the status changes to PAUSED, and after 60 seconds the archive recording stops (and the status changes to STOPPED).
STARTED
public static final Archive.Status STARTED
The archive recording has started and is in progress.
STOPPED
public static final Archive.Status STOPPED
The archive recording has stopped, but the file is not available.
UPLOADED
public static final Archive.Status UPLOADED
The archive is available for download from the the upload target Amazon S3 bucket or Windows Azure container you set up for your OpenTok project.
EXPIRED
public static final Archive.Status EXPIRED
The archive file is no longer available at the OpenTok cloud.
Method Details
values
public static Archive.Status[] 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 Archive.Status 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<Archive.Status>