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

A

Archive - Class in com.opentok

Represents an archive of an OpenTok session.

Archive.Status - Enum in com.opentok

Defines values returned by the Archive.getStatus() method.

B

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.

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 "90 mins exceeded", "failure", "session ended", or "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.

getUrl() - Method in class com.opentok.Archive

The download URL of the available MP4 file.

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.

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.

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 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, String) - Method in class com.opentok.OpenTok

Starts archiving an OpenTok 2.0 session.

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.SessionProperties

Returns the session properties as a Map.

toString() - Method in enum com.opentok.Archive.Status

toString() - Method in class com.opentok.Archive

toString() - Method in enum com.opentok.MediaMode

toString() - Method in enum com.opentok.Role

V

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.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.Status

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 I L M O R S T V