A B C D E G H I L M N O R S T V 

A

Archive - Class in com.opentok
Represents an archive of an OpenTok session.
Archive.OutputMode - Enum in com.opentok
Defines values used in the ArchiveProperties.Builder.outputMode(com.opentok.Archive.OutputMode) method and returned by the Archive.getOutputMode() method.
Archive.Status - Enum in com.opentok
Defines values returned by the Archive.getStatus() method.
ArchiveList - Class in com.opentok
Represents an list of archives of OpenTok session(s).
ArchiveList() - Constructor for class com.opentok.ArchiveList
 
ArchiveMode - Enum in com.opentok
Defines values for the archiveMode parameter of the SessionProperties.Builder.archiveMode(ArchiveMode archiveMode) method.
archiveMode() - Method in class com.opentok.SessionProperties
Defines whether the session will be automatically archived (ArchiveMode.ALWAYS) or not (ArchiveMode.MANUAL).
archiveMode(ArchiveMode) - Method in class com.opentok.SessionProperties.Builder
Call this method to determine whether the session will be automatically archived (ArchiveMode.ALWAYS) or not (ArchiveMode.MANUAL).
ArchiveProperties - Class in com.opentok
Defines values for the properties parameter of the OpenTok.createSession(SessionProperties) method.
ArchiveProperties.Builder - Class in com.opentok
Use this class to create a ArchiveProperties object.
ArchiveProperties.Builder() - Constructor for class com.opentok.ArchiveProperties.Builder
 

B

build() - Method in class com.opentok.ArchiveProperties.Builder
Builds the ArchiveProperties object.
build() - Method in class com.opentok.SessionProperties.Builder
Builds the SessionProperties object.
build() - Method in class com.opentok.TokenOptions.Builder
Builds the TokenOptions object.

C

com.opentok - package com.opentok
Includes the main classes of the OpenTok 2.2 Java SDK.
com.opentok.exception - package com.opentok.exception
Defines exceptions for the OpenTok Java SDK.
createSession(SessionProperties) - Method in class com.opentok.OpenTok
Creates a new OpenTok session.
createSession() - Method in class com.opentok.OpenTok
Creates an OpenTok session with the default settings:

D

data(String) - Method in class com.opentok.TokenOptions.Builder
A string containing connection metadata describing the end-user.
deleteArchive(String) - Method in class com.opentok.OpenTok
Deletes an OpenTok archive.

E

expireTime(double) - Method in class com.opentok.TokenOptions.Builder
Sets the expiration time for the token.

G

generateToken(String, TokenOptions) - Method in class com.opentok.OpenTok
Creates a token for connecting to an OpenTok session.
generateToken(String) - Method in class com.opentok.OpenTok
Creates a token for connecting to an OpenTok session, using the default settings.
generateToken() - Method in class com.opentok.Session
Generates the token for the session.
generateToken(TokenOptions) - Method in class com.opentok.Session
Creates a token for connecting to an OpenTok session.
getApiKey() - Method in class com.opentok.Session
Returns the OpenTok API key used to generate the session.
getArchive(String) - Method in class com.opentok.OpenTok
Gets an Archive object for the given archive ID.
getCreatedAt() - Method in class com.opentok.Archive
The time at which the archive was created, in milliseconds since the Unix epoch.
getData() - Method in class com.opentok.TokenOptions
Returns the connection metadata assigned to the token.
getDuration() - Method in class com.opentok.Archive
The duration of the archive, in milliseconds.
getExpireTime() - Method in class com.opentok.TokenOptions
Returns the expiration time the token, as the number of seconds since the UNIX epoch.
getId() - Method in class com.opentok.Archive
The archive ID.
getLocation() - Method in class com.opentok.SessionProperties
The location hint IP address.
getName() - Method in class com.opentok.Archive
The name of the archive.
getOutputMode() - Method in class com.opentok.Archive
The output mode to be generated for this archive: composed or individual.
getPartnerId() - Method in class com.opentok.Archive
The OpenTok API key associated with the archive.
getProperties() - Method in class com.opentok.Session
Returns the properties defining the session.
getReason() - Method in class com.opentok.Archive
For archives with the status of Status.STOPPED, this can be set to "maximum duration exceeded", "maximum idle time exceeded", "session ended", "user initiated".
getRole() - Method in class com.opentok.TokenOptions
Returns the role assigned to the token.
getSessionId() - Method in class com.opentok.Archive
The session ID of the OpenTok session associated with this archive.
getSessionId() - Method in class com.opentok.Session
Returns the session ID, which uniquely identifies the session.
getSize() - Method in class com.opentok.Archive
The size of the MP4 file.
getStatus() - Method in class com.opentok.Archive
The status of the archive, as defined by the Archive.Status enum.
getTotalCount() - Method in class com.opentok.ArchiveList
The total number of Archives for the API Key.
getUrl() - Method in class com.opentok.Archive
The download URL of the available MP4 file.

H

hasAudio() - Method in class com.opentok.Archive
Whether the archive has an audio track (true) or not (false).
hasAudio(boolean) - Method in class com.opentok.ArchiveProperties.Builder
Call this method to include an audio track (true) or not false).
hasAudio() - Method in class com.opentok.ArchiveProperties
Whether the archive has an audio track (true) or not (false).
hasVideo() - Method in class com.opentok.Archive
Whether the archive has a video track (true) or not (false).
hasVideo(boolean) - Method in class com.opentok.ArchiveProperties.Builder
Call this method to include an video track (true) or not false).
hasVideo() - Method in class com.opentok.ArchiveProperties
Whether the archive has a video track (true) or not (false).

I

InvalidArgumentException - Exception in com.opentok.exception
Defines an exception object thrown when an invalid argument is passed into a method.
InvalidArgumentException(String) - Constructor for exception com.opentok.exception.InvalidArgumentException
Constructor.

L

listArchives() - Method in class com.opentok.OpenTok
Returns a List of Archive objects, representing archives that are both both completed and in-progress, for your API key.
listArchives(int, int) - Method in class com.opentok.OpenTok
Returns a List of Archive objects, representing archives that are both both completed and in-progress, for your API key.
location(String) - Method in class com.opentok.SessionProperties.Builder
Call this method to set an IP address that the OpenTok servers will use to situate the session in its global network.

M

makeArchive() - Static method in class com.opentok.Archive
 
MediaMode - Enum in com.opentok
Defines values for the mediaMode parameter of the SessionProperties.Builder.mediaMode(MediaMode mediaMode) method.
mediaMode(MediaMode) - Method in class com.opentok.SessionProperties.Builder
Call this method to determine whether the session will transmit streams using the OpenTok Media Router (MediaMode.ROUTED) or not (MediaMode.RELAYED).
mediaMode() - Method in class com.opentok.SessionProperties
Defines whether the session will transmit streams using the OpenTok Media Server or attempt to transmit streams directly between clients.

N

name(String) - Method in class com.opentok.ArchiveProperties.Builder
Call this method to set a name to the archive.
name() - Method in class com.opentok.ArchiveProperties
Returns the name of the archive, which you can use to identify the archive

O

OpenTok - Class in com.opentok
Contains methods for creating OpenTok sessions, generating tokens, and working with archives.
OpenTok(int, String) - Constructor for class com.opentok.OpenTok
Creates an OpenTok object.
OpenTok(int, String, String) - Constructor for class com.opentok.OpenTok
 
OpenTokException - Exception in com.opentok.exception
Defines exceptions in the OpenTok SDK.
OpenTokException(String) - Constructor for exception com.opentok.exception.OpenTokException
Constructor.
OpenTokException(String, Throwable) - Constructor for exception com.opentok.exception.OpenTokException
Constructor.
outputMode(Archive.OutputMode) - Method in class com.opentok.ArchiveProperties.Builder
Call this method to choose the output mode to be generated for this archive.
outputMode() - Method in class com.opentok.ArchiveProperties
The output mode of the archive.

R

RequestException - Exception in com.opentok.exception
Defines an exception object thrown when an API call to the OpenTok server fails.
RequestException(String) - Constructor for exception com.opentok.exception.RequestException
Constructor.
RequestException(String, Throwable) - Constructor for exception com.opentok.exception.RequestException
Constructor.
Role - Enum in com.opentok
Defines values for the role parameter of the TokenOptions.Builder.role(Role role) method.
role(Role) - Method in class com.opentok.TokenOptions.Builder
Sets the role for the token.

S

Session - Class in com.opentok
Represents an OpenTok session.
SessionProperties - Class in com.opentok
Defines values for the properties parameter of the OpenTok.createSession(SessionProperties) method.
SessionProperties.Builder - Class in com.opentok
Use this class to create a SessionProperties object.
SessionProperties.Builder() - Constructor for class com.opentok.SessionProperties.Builder
 
startArchive(String, ArchiveProperties) - Method in class com.opentok.OpenTok
Starts archiving an OpenTok session.
startArchive(String) - Method in class com.opentok.OpenTok
 
startArchive(String, String) - Method in class com.opentok.OpenTok
 
stopArchive(String) - Method in class com.opentok.OpenTok
Stops an OpenTok archive that is being recorded.

T

TokenOptions - Class in com.opentok
Defines values for the tokenOptions parameter of the OpenTok.generateToken(String sessionId, TokenOptions tokenOptions) method and the Session.generateToken(TokenOptions tokenOptions) method.
TokenOptions.Builder - Class in com.opentok
Use this class to create a TokenOptions object.
TokenOptions.Builder() - Constructor for class com.opentok.TokenOptions.Builder
 
toMap() - Method in class com.opentok.ArchiveProperties
Returns the archive properties as a Map.
toMap() - Method in class com.opentok.SessionProperties
Returns the session properties as a Map.
toString() - Method in enum com.opentok.Archive.OutputMode
 
toString() - Method in enum com.opentok.Archive.Status
 
toString() - Method in class com.opentok.Archive
 
toString() - Method in enum com.opentok.ArchiveMode
 
toString() - Method in enum com.opentok.MediaMode
 
toString() - Method in enum com.opentok.Role
 

V

valueOf(String) - Static method in enum com.opentok.Archive.OutputMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.opentok.Archive.Status
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.opentok.ArchiveMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.opentok.MediaMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.opentok.Role
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.opentok.Archive.OutputMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.opentok.Archive.Status
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.opentok.ArchiveMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.opentok.MediaMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.opentok.Role
Returns an array containing the constants of this enum type, in the order they are declared.
A B C D E G H I L M N O R S T V