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

A

addArchiveStream(String, String, boolean, boolean) - Method in class com.opentok.OpenTok

Adds a stream to an OpenTok archive.

addBroadcastStream(String, String, boolean, boolean) - Method in class com.opentok.OpenTok

Adds a stream to an Opentok broadcast.

addHeader(String, String) - Method in class com.opentok.AudioConnectorProperties.Builder

Adds a header entry to this object's headers property.

addHeaders(Map<String, String>) - Method in class com.opentok.AudioConnectorProperties.Builder

Puts all entries of the map into the headers parameter.

addLayoutClass(String) - Method in class com.opentok.StreamProperties.Builder

Call this method to set an individual layout class for the stream.

addRtmpProperties(RtmpProperties) - Method in class com.opentok.BroadcastProperties.Builder

Call this method to set a list of RTMP broadcast streams.

addStream(String) - Method in class com.opentok.AudioConnectorProperties.Builder

Adds an OpenTok stream (with the corresponding stream ID) to include in the WebSocket audio.

addStreamProperties(StreamProperties) - Method in class com.opentok.StreamListProperties.Builder

Call this method to set layout class list of a stream.

addStreams(String...) - Method in class com.opentok.AudioConnectorProperties.Builder

Adds OpenTok streams (with the corresponding stream IDs) to include in the WebSocket audio.

addStreams(Collection<String>) - Method in class com.opentok.AudioConnectorProperties.Builder

Adds OpenTok streams (with the corresponding stream IDs) to include in the WebSocket audio.

apiUrl(String) - Method in class com.opentok.OpenTok.Builder

Do not use.

appendToUserAgent(String) - Method in class com.opentok.OpenTok.Builder

Append a custom string to the client's User-Agent.

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.

Archive.StreamMode - Enum in com.opentok

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

ArchiveLayout - Class in com.opentok

Represents a layout configuration for a composed archive.

ArchiveLayout(ArchiveLayout.Type, String) - Constructor for class com.opentok.ArchiveLayout

Do not call the ArchiveLayout() constructor.

ArchiveLayout(ArchiveLayout.Type) - Constructor for class com.opentok.ArchiveLayout

Do not call the ArchiveLayout() constructor.

ArchiveLayout(ScreenShareLayoutType) - Constructor for class com.opentok.ArchiveLayout

Do not call the ArchiveLayout() constructor.

ArchiveLayout.Type - Enum in com.opentok

Enumerates type values for the layout.

ArchiveList - Class in com.opentok

Represents a 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).

archiveName() - Method in class com.opentok.SessionProperties

Indicates the archive resolution for all the archives in auto archived session.

archiveName(String) - Method in class com.opentok.SessionProperties.Builder

Indicates the archive name for all the archives in auto archived session.

ArchiveProperties - Class in com.opentok

Defines values for the properties parameter of the OpenTok.startArchive(String sessionId, ArchiveProperties properties) method.

ArchiveProperties.Builder - Class in com.opentok

Used to create an ArchiveProperties object.

archiveResolution() - Method in class com.opentok.SessionProperties

Indicates the archive resolution for all the archives in auto archived session.

archiveResolution(Resolution) - Method in class com.opentok.SessionProperties.Builder

Indicates the archive resolution for all the archives in auto archived session.

AudioConnector - Class in com.opentok

Represents an Audio Connector instance.

AudioConnectorProperties - Class in com.opentok

Defines values for the properties parameter of the OpenTok.connectAudioStream(String, String, AudioConnectorProperties) method.

AudioConnectorProperties.Builder - Class in com.opentok

Intermediary stateful object used to construct AudioConnectorProperties.

B

Broadcast - Class in com.opentok

Represents a live streaming broadcast of an OpenTok session.

Broadcast.StreamMode - Enum in com.opentok

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

BroadcastLayout - Class in com.opentok

Represents a layout configuration for a live streaming broadcast.

BroadcastLayout(ArchiveLayout.Type, String) - Constructor for class com.opentok.BroadcastLayout

Do not call the BroadcastLayout() constructor.

BroadcastLayout(ArchiveLayout.Type) - Constructor for class com.opentok.BroadcastLayout

Do not call the BroadcastLayout() constructor.

BroadcastLayout(ScreenShareLayoutType) - Constructor for class com.opentok.BroadcastLayout

Do not call the BroadcastLayout() constructor.

BroadcastProperties - Class in com.opentok

Defines values for the properties parameter of the OpenTok.startBroadcast(String sessionId, BroadcastProperties properties) method.

BroadcastProperties.Builder - Class in com.opentok

Used to create a BroadcastProperties object.

build() - Method in class com.opentok.ArchiveProperties.Builder

Builds the ArchiveProperties object.

build() - Method in class com.opentok.AudioConnectorProperties.Builder

Builds the AudioConnectorProperties object.

build() - Method in class com.opentok.BroadcastProperties.Builder

Builds the BroadcastProperties object.

build() - Method in class com.opentok.CaptionProperties.Builder

Builds the CaptionProperties object.

build() - Method in class com.opentok.Hls.Builder

Builds the HLS object with the selected settings.

build() - Method in class com.opentok.MuteAllProperties.Builder

Builds the MuteAllProperties object.

build() - Method in class com.opentok.OpenTok.Builder

Builds the OpenTok object with the settings provided to this Builder object.

build() - Method in class com.opentok.RenderProperties.Builder

Builds the RenderProperties object.

build() - Method in class com.opentok.RtmpProperties.Builder

Builds the RtmpProperties object.

build() - Method in class com.opentok.SessionProperties.Builder

Builds the SessionProperties object.

build() - Method in class com.opentok.SignalProperties.Builder

Builds the SignalProperties object.

build() - Method in class com.opentok.SipProperties.Builder

Builds the SipProperties object.

build() - Method in class com.opentok.StreamListProperties.Builder

Builds the StreamListProperties object.

build() - Method in class com.opentok.StreamProperties.Builder

Builds the StreamProperties object.

build() - Method in class com.opentok.TokenOptions.Builder

Builds the TokenOptions object.

Builder() - Constructor for class com.opentok.ArchiveProperties.Builder

Builder(URI) - Constructor for class com.opentok.AudioConnectorProperties.Builder

Constructor for the AudioConnectorProperties.Builder, using a URI to define the WebSocket URI.

Builder(String) - Constructor for class com.opentok.AudioConnectorProperties.Builder

Constructor for the AudioConnectorProperties.Builder, using a string to define the WebSocket URI.

Builder() - Constructor for class com.opentok.BroadcastProperties.Builder

Builder() - Static method in class com.opentok.CaptionProperties

Entry point for constructing an instance of this class.

Builder() - Constructor for class com.opentok.Hls.Builder

Builder() - Constructor for class com.opentok.MuteAllProperties.Builder

Builder(int, String) - Constructor for class com.opentok.OpenTok.Builder

Constructs a new OpenTok.Builder object.

Builder() - Static method in class com.opentok.RenderProperties

Entry point for constructing an instance of RenderProperties.

Builder() - Constructor for class com.opentok.RenderProperties.Builder

Builder() - Constructor for class com.opentok.RtmpProperties.Builder

Builder() - Constructor for class com.opentok.SessionProperties.Builder

Builder() - Constructor for class com.opentok.SignalProperties.Builder

Builder() - Constructor for class com.opentok.SipProperties.Builder

Builder() - Constructor for class com.opentok.StreamListProperties.Builder

Builder() - Constructor for class com.opentok.StreamProperties.Builder

Builder() - Constructor for class com.opentok.TokenOptions.Builder

C

Caption - Class in com.opentok

Represents the response from OpenTok.startCaptions(String, String, CaptionProperties).

Caption() - Constructor for class com.opentok.Caption

CaptionProperties - Class in com.opentok

Defines values for the properties parameter of the OpenTok.startCaptions(String, String, CaptionProperties) method.

CaptionProperties.Builder - Class in com.opentok

Used to create a CaptionProperties object.

close() - Method in class com.opentok.OpenTok

Call this method when you are done using the OpenTok object, to prevent leaked file descriptors.

com.opentok - package com.opentok

Includes the main classes of the OpenTok Java SDK.

com.opentok.exception - package com.opentok.exception

Defines exceptions for the OpenTok Java SDK.

connectAudioStream(String, String, AudioConnectorProperties) - Method in class com.opentok.OpenTok

Send audio from a Vonage Video API session to a WebSocket.

CreatedSession - Class in com.opentok

Used internally.

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.SignalProperties.Builder

Call this method to set data of the signal.

data() - Method in class com.opentok.SignalProperties

Returns the type of the signal

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.

dial(String, String, SipProperties) - Method in class com.opentok.OpenTok

Dials a SIP gateway to connect it an OpenTok session.

disableForceMute(String) - Method in class com.opentok.OpenTok

Disables the active mute state of the session.

dvr(boolean) - Method in class com.opentok.Hls.Builder

Whether to enable DVR functionality — rewinding, pausing, and resuming — in players that support it (true), or not (false, the default).

dvr() - Method in class com.opentok.Hls

Whether DVR functionality — rewinding, pausing, and resuming — is enabled in players that support it.

E

endToEndEncryption() - Method in class com.opentok.SessionProperties.Builder

Enables end-to-end encryption for a routed session.

excludedStreamIds(List<String>) - Method in class com.opentok.MuteAllProperties.Builder

Call this method to add a List of stream IDs for streams to be excluded from the force mute action.

expireTime(long) - Method in class com.opentok.TokenOptions.Builder

Sets the expiration time for the token.

F

forceDisconnect(String, String) - Method in class com.opentok.OpenTok

Disconnect a client from an OpenTok session

forceMuteAll(String, MuteAllProperties) - Method in class com.opentok.OpenTok

Forces all streams (except for an optional array of streams) in a session to mute published audio.

forceMuteStream(String, String) - Method in class com.opentok.OpenTok

Force the publisher of a specific stream to mute its audio.

from(String) - Method in class com.opentok.SipProperties.Builder

Call this method to set the SIP from field (optional).

from() - Method in class com.opentok.SipProperties

Returns the from value.

fromString(String) - Static method in enum com.opentok.RenderStatus

fromString(String) - Static method in enum com.opentok.Resolution

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.

getBroadcast(String) - Method in class com.opentok.OpenTok

Gets an Broadcast object for the given broadcast ID.

getCaptionsId() - Method in class com.opentok.Caption

The unique ID for the audio captioning session.

getConnectionId() - Method in class com.opentok.AudioConnector

getConnectionId() - Method in class com.opentok.Sip

The connection ID of the audio-only stream that is put into an OpenTok Session.

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

The time at which the archive was created, in milliseconds since the Unix epoch.

getCreatedAt() - Method in class com.opentok.Broadcast

The time at which the broadcast was started, in milliseconds since the Unix epoch.

getCreatedAt() - Method in class com.opentok.Render

The time the Experience Composer started, expressed in milliseconds since the Unix epoch.

getCreateDt() - Method in class com.opentok.CreatedSession

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

getExcludedStreamIds() - Method in class com.opentok.MuteAllProperties

Returns the excludedStreams list.

getExpireTime() - Method in class com.opentok.TokenOptions

Returns the expiration time the token, as the number of seconds since the UNIX epoch.

getHls() - Method in class com.opentok.Broadcast

The HLS URL (if there is one) of the broadcast.

getHlsStatus() - Method in class com.opentok.Broadcast

The HLS status of the broadcast if known.

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

The archive ID.

getId() - Method in class com.opentok.AudioConnector

getId() - Method in class com.opentok.Broadcast

The broadcast ID.

getId() - Method in class com.opentok.CreatedSession

getId() - Method in class com.opentok.Render

The Render ID.

getId() - Method in class com.opentok.Rtmp

getId() - Method in class com.opentok.Sip

The unique ID of the SIP conference.

getId() - Method in class com.opentok.Stream

The stream ID.

getInitialLayoutClassList() - Method in class com.opentok.TokenOptions

Returns the initial layout class list for streams published by the client using this token.

getLanguageCode() - Method in class com.opentok.CaptionProperties

The BCP-47 code for a spoken language used on this call.

getLayoutClassList() - Method in class com.opentok.Stream

The layout class list of the stream.

getLayoutClassList() - Method in class com.opentok.StreamProperties

Returns the list of layout classes for the stream.

getLocation() - Method in class com.opentok.SessionProperties

The location hint IP address.

getMaxBitrate() - Method in class com.opentok.Broadcast

Maximum bitrate (bits per second) is an optional value allowed for the broadcast composing.

getMaxDuration() - Method in class com.opentok.Broadcast

The maximum duration of the broadcast in seconds.

getMaxDuration() - Method in class com.opentok.CaptionProperties

The maximum duration for the audio captioning, in seconds.

getMediaServerURL() - Method in class com.opentok.CreatedSession

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

Returns the multiArchiveTag if set for the Archive.

getMultiArchiveTag() - Method in class com.opentok.ArchiveProperties

Returns the multiArchiveTag, if present.

getMultiBroadcastTag() - Method in class com.opentok.Broadcast

Returns the multiBroadcastTag if set for the Broadcast.

getMultiBroadcastTag() - Method in class com.opentok.BroadcastProperties

Returns the multiBroadcastTag, if present.

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

The name of the archive.

getName() - Method in class com.opentok.Stream

The name of the stream.

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.

getPartnerId() - Method in class com.opentok.CreatedSession

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

The encrypted password if an archive storage was configured to use an encryption key

getProjectId() - Method in class com.opentok.Broadcast

The OpenTok API key associated with the broadcast.

getProjectId() - Method in class com.opentok.CreatedSession

getProjectId() - Method in class com.opentok.Render

The Project ID.

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 Status.STOPPED or Status.FAILED, this string describes the reason the archive stopped (such as "maximum duration exceeded") or failed.

getReason() - Method in class com.opentok.Render

The reason field is only available when the status is either "stopped" or "failed".

getRender(String) - Method in class com.opentok.OpenTok

Gets a Render object, with details on an Experience Composer.

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

The resolution of the archive.

getResolution() - Method in class com.opentok.Broadcast

The broadcast resolution.

getResolution() - Method in class com.opentok.Render

The resolution of the Experience Composer (either "640x480", "1280x720", "480x640", or "720x1280").

getRole() - Method in class com.opentok.TokenOptions

Returns the role assigned to the token.

getRtmpList() - Method in class com.opentok.Broadcast

A list of RTMP URLs (if there are any) of the broadcast.

getScreenshareType() - Method in class com.opentok.ArchiveLayout

getServerUrl() - Method in class com.opentok.Rtmp

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

The session ID of the OpenTok session associated with this archive.

getSessionId() - Method in class com.opentok.Broadcast

The session ID of the OpenTok session associated with this broadcast.

getSessionId() - Method in class com.opentok.Render

The Session ID.

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.

getStatus() - Method in class com.opentok.Broadcast

The broadcast status, either "started" or "stopped".

getStatus() - Method in class com.opentok.Render

The status of the Experience Composer.

getStatus() - Method in class com.opentok.Rtmp

getStatusCallbackUrl() - Method in class com.opentok.CaptionProperties

A publicly reachable URL controlled by the customer and capable of generating the content to be rendered without user intervention.

getStream(String, String) - Method in class com.opentok.OpenTok

Gets a Stream object for the given session ID and stream ID.

getStreamId() - Method in class com.opentok.Render

The ID of the composed stream being published.

getStreamId() - Method in class com.opentok.Sip

The stream ID of the audio-only stream that is put into an OpenTok Session.

getStreamList() - Method in class com.opentok.StreamListProperties

Returns the StreamProperties list.

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

The stream mode to used for selecting streams to be included in this archive: StreamMode.AUTO or StreamMode.MANUAL.

getStreamMode() - Method in class com.opentok.Broadcast

The stream mode to used for selecting streams to be included in this archive: StreamMode.AUTO or StreamMode.MANUAL.

getStreamName() - Method in class com.opentok.Rtmp

getStylesheet() - Method in class com.opentok.ArchiveLayout

Returns the stylesheet for a custom layout.

getTotalCount() - Method in class com.opentok.ArchiveList

The total number of Archives for the API Key.

getTotalCount() - Method in class com.opentok.StreamList

The total number of Streams in the StreamList.

getType() - Method in class com.opentok.ArchiveLayout

Returns the layout type.

getUpdatedAt() - Method in class com.opentok.Broadcast

The time at which the broadcast was updated, in milliseconds since the Unix epoch.

getUpdatedAt() - Method in class com.opentok.Render

This timestamp matches the createdAt timestamp when calling OpenTok.getRender(String).

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

The download URL of the available MP4 file.

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

A publicly reachable URL controlled by the customer and capable of generating the content to be rendered without user intervention.

getVideoType() - Method in class com.opentok.Stream

The stream videoType.

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, the default) or not false).

hasAudio() - Method in class com.opentok.ArchiveProperties

Whether the archive has an audio track (true) or not (false).

hasAudio() - Method in class com.opentok.Broadcast

Whether the broadcast has audio (true) or not (false).

hasAudio(boolean) - Method in class com.opentok.BroadcastProperties.Builder

Whether to include audio in the broadcast (true by default).

hasAudio() - Method in class com.opentok.BroadcastProperties

Whether the broadcast has audio (true) or not (false).

hasHls(boolean) - Method in class com.opentok.BroadcastProperties.Builder

Call this method to include an HLS broadcast (true) or not false).

hasHls() - Method in class com.opentok.BroadcastProperties

Whether the broadcast has HLS (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, the default) or not false).

hasVideo() - Method in class com.opentok.ArchiveProperties

Whether the archive has a video track (true) or not (false).

hasVideo() - Method in class com.opentok.Broadcast

Whether the broadcast has video (true) or not (false).

hasVideo(boolean) - Method in class com.opentok.BroadcastProperties.Builder

Whether to include video in the broadcast (true by default).

hasVideo() - Method in class com.opentok.BroadcastProperties

Whether the broadcast has video (true) or not (false).

headers() - Method in class com.opentok.AudioConnectorProperties

Additional headers to include in the request body.

headersJsonStartingWithXDash(String) - Method in class com.opentok.SipProperties.Builder

Call this method to define custom headers to be added to the SIP INVITE initiated from OpenTok to your SIP platform.

headersJsonStartingWithXDash() - Method in class com.opentok.SipProperties

Returns the SIP headers as JSON.

hls(Hls) - Method in class com.opentok.BroadcastProperties.Builder

Call this method to include HLS options.

hls() - Method in class com.opentok.BroadcastProperties

The HLS configuration object, or null if BroadcastProperties.hasHls is false.

Hls - Class in com.opentok

Represents HLS options for a live streaming broadcast.

Hls.Builder - Class in com.opentok

Used to create the Hls object.

I

id - Variable in class com.opentok.Rtmp

id(String) - Method in class com.opentok.RtmpProperties.Builder

Call this method to set the ID of the RTMP stream (optional).

id() - Method in class com.opentok.RtmpProperties

Returns the ID of the broadcast stream

id(String) - Method in class com.opentok.StreamProperties.Builder

Call this method to set the ID of the stream.

id() - Method in class com.opentok.StreamProperties

Returns the ID of the stream.

initialLayoutClassList(List<String>) - Method in class com.opentok.TokenOptions.Builder

A List of class names (strings) to be used as the initial layout classes for streams published by the client.

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.

isEndToEndEncrypted() - Method in class com.opentok.SessionProperties

Defines whether the session will use end-to-end encryption.

L

languageCode(String) - Method in class com.opentok.CaptionProperties.Builder

The BCP-47 code for a spoken language used on this call.

layout(ArchiveLayout) - Method in class com.opentok.ArchiveProperties.Builder

Sets the layout for a composed archive.

layout() - Method in class com.opentok.ArchiveProperties

Returns the custom layout of the archive (composed archives only).

layout(BroadcastLayout) - Method in class com.opentok.BroadcastProperties.Builder

Customizes the layout of the broadcast.

layout() - Method in class com.opentok.BroadcastProperties

The layout of the broadcast.

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(String) - 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.

listArchives(String, 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.

listRenders() - Method in class com.opentok.OpenTok

Gets a list of Render objects, representing Experience Composers associated with the OpenTok project.

listRenders(Integer, Integer) - Method in class com.opentok.OpenTok

Gets a list of Render objects, representing a list of Experience Composers associated with the OpenTok project.

listStreams(String) - Method in class com.opentok.OpenTok

Gets a list of Stream objects for the given session ID.

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.

lowLatency(boolean) - Method in class com.opentok.Hls.Builder

Whether to enable low-latency mode for the HLSstream.

lowLatency() - Method in class com.opentok.Hls

Whether low-latency mode is enabled for the HLSstream.

M

makeArchive() - Static method in class com.opentok.Archive

makeBroadcast() - Static method in class com.opentok.Broadcast

Do not call the makeBroadcast() method.

makeConnection() - Static method in class com.opentok.AudioConnector

Do not call this method.

makeSession() - Static method in class com.opentok.CreatedSession

Used internally.

makeSip() - Static method in class com.opentok.Sip

Used internally.

makeStream() - Static method in class com.opentok.Stream

maxBitrate(int) - Method in class com.opentok.BroadcastProperties.Builder

Sets the maximum bitrate in bits per second for broadcast composing.

maxBitrate() - Method in class com.opentok.BroadcastProperties

The maximum bitrate in bits per second of the broadcast.

maxDuration(int) - Method in class com.opentok.BroadcastProperties.Builder

Sets the maximum duration, in seconds, of the broadcast.

maxDuration() - Method in class com.opentok.BroadcastProperties

The maximum duration in seconds of the broadcast.

maxDuration(int) - Method in class com.opentok.CaptionProperties.Builder

The maximum duration for the audio captioning, in seconds.

maxDuration(int) - Method in class com.opentok.RenderProperties.Builder

maxDuration() - Method in class com.opentok.RenderProperties

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.

multiArchiveTag(String) - Method in class com.opentok.ArchiveProperties.Builder

Set this to support recording multiple archives for the same session simultaneously.

multiBroadcastTag(String) - Method in class com.opentok.BroadcastProperties.Builder

Set this to support multiple broadcasts for the same session simultaneously.

MuteAllProperties - Class in com.opentok

Defines values for the properties parameter of the OpenTok.forceMuteAll(String, MuteAllProperties) method.

MuteAllProperties.Builder - Class in com.opentok

Use this class to create a MuteAllProperties object.

N

name(String) - Method in class com.opentok.ArchiveProperties.Builder

Sets a name for the archive.

name() - Method in class com.opentok.ArchiveProperties

Returns the name of the archive, which you can use to identify the archive.

name() - Method in class com.opentok.RenderProperties.Properties

O

observeForceMute(boolean) - Method in class com.opentok.SipProperties.Builder

Call this method and pass in true to have the SIP end point observe force mute moderation.

observeForceMute() - Method in class com.opentok.SipProperties

Returns the observeForceMute value (true or false).

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.Builder - Class in com.opentok

Used to create an OpenTok object with advanced settings.

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

Sets the output mode for this archive.

outputMode() - Method in class com.opentok.ArchiveProperties

The output mode of the archive.

P

partialCaptions(boolean) - Method in class com.opentok.CaptionProperties.Builder

Whether to enable this to faster captioning at the cost of some degree of inaccuracies.

partialCaptions() - Method in class com.opentok.CaptionProperties

Whether faster captioning is enabled at the cost of some degree of inaccuracies.

password(String) - Method in class com.opentok.SipProperties.Builder

Call this method to set the password for the SIP gateway provider (optional).

password() - Method in class com.opentok.SipProperties

Returns the password.

playDTMF(String, String) - Method in class com.opentok.OpenTok

Send DTMF digits to all clients in a session.

playDTMF(String, String, String) - Method in class com.opentok.OpenTok

Send DTMF digits a specific client in a session.

properties(RenderProperties.Properties) - Method in class com.opentok.RenderProperties.Builder

Initial configuration of Publisher properties for the composed output stream.

properties() - Method in class com.opentok.RenderProperties

Properties(String) - Constructor for class com.opentok.RenderProperties.Properties

proxy(Proxy) - Method in class com.opentok.OpenTok.Builder

Sets a proxy server that the HTTP client will use when making calls to the OpenTok REST API.

proxy(Proxy, HttpClient.ProxyAuthScheme, String, String) - Method in class com.opentok.OpenTok.Builder

R

removeArchiveStream(String, String) - Method in class com.opentok.OpenTok

Removes a stream from an Opentok archive.

removeBroadcastStream(String, String) - Method in class com.opentok.OpenTok

Removes a stream from an Opentok broadcast.

Render - Class in com.opentok

Represents an Experience Composer element response.

RenderProperties - Class in com.opentok

Defines values for the properties parameter of the OpenTok.startRender(String sessionId, String token, RenderProperties properties) method.

RenderProperties.Builder - Class in com.opentok

Builder for defining the parameters of RenderProperties.

RenderProperties.Properties - Class in com.opentok

Represents the properties parameter of RenderProperties.

RenderProperties.Resolution - Enum in com.opentok

Represents the resolution parameter of RenderProperties.

RenderStatus - Enum in com.opentok

Enum representing the status of a Render.

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.

requestTimeout(int) - Method in class com.opentok.OpenTok.Builder

Specify the timeout for HTTP requests (in seconds).

resolution(String) - Method in class com.opentok.ArchiveProperties.Builder

Sets the resolution of the archive.

resolution() - Method in class com.opentok.ArchiveProperties

Returns the resolution of the archive.

resolution(String) - Method in class com.opentok.BroadcastProperties.Builder

Sets the resolution of the broadcast stream.

resolution() - Method in class com.opentok.BroadcastProperties

Returns the resolution of the broadcast.

resolution(RenderProperties.Resolution) - Method in class com.opentok.RenderProperties.Builder

Resolution of the display area for the composition.

resolution() - Method in class com.opentok.RenderProperties

Resolution - Enum in com.opentok

Defines valid video resolutions.

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.

Rtmp - Class in com.opentok

Represents an RTMP stream in an OpenTok session.

Rtmp() - Constructor for class com.opentok.Rtmp

rtmpList() - Method in class com.opentok.BroadcastProperties

Returns the RtmpProperties list.

RtmpProperties - Class in com.opentok

Defines values for the RtmpProperties value of the BroadcastProperties parameter of the OpenTok.startBroadcast(String, BroadcastProperties)

RtmpProperties.Builder - Class in com.opentok

Use this class to create a RtmpProperties object.

S

ScreenShareLayoutType - Enum in com.opentok

Enumerates type values for the layout.

secure(boolean) - Method in class com.opentok.SipProperties.Builder

Call this method and pass in true to indicate that the media must be transmitted encrypted.

secure() - Method in class com.opentok.SipProperties

Returns the secure value (true or false).

serverUrl(String) - Method in class com.opentok.RtmpProperties.Builder

Call this method to set the RTMP server URL.

serverUrl() - Method in class com.opentok.RtmpProperties

Returns the RTMP server URL of the broadcast stream.

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.

setArchiveLayout(String, ArchiveProperties) - Method in class com.opentok.OpenTok

Sets the layout type for a composed archive.

setBroadcastLayout(String, BroadcastProperties) - Method in class com.opentok.OpenTok

Sets the layout type for the broadcast.

setId(String) - Method in class com.opentok.Rtmp

The stream ID.

setScreenshareType(ScreenShareLayoutType) - Method in class com.opentok.ArchiveLayout

setServerUrl(String) - Method in class com.opentok.Rtmp

The RTMP server URL.

setStatus(String) - Method in class com.opentok.Rtmp

setStreamLayouts(String, StreamListProperties) - Method in class com.opentok.OpenTok

Sets the layout class list for streams in a session.

setStreamName(String) - Method in class com.opentok.Rtmp

The stream name.

setStylesheet(String) - Method in class com.opentok.ArchiveLayout

Sets the stylesheet for a custom layout.

setType(ArchiveLayout.Type) - Method in class com.opentok.ArchiveLayout

Sets the layout type.

signal(String, SignalProperties) - Method in class com.opentok.OpenTok

Sends a signal to all clients connected to a session.

signal(String, String, SignalProperties) - Method in class com.opentok.OpenTok

Sends a signal to a specific client connected to a session.

SignalProperties - Class in com.opentok

Defines values for the properties parameter of the OpenTok.signal(String, SignalProperties) (String, String)} method.

SignalProperties.Builder - Class in com.opentok

Use this class to create a SignalProperties object.

Sip - Class in com.opentok

An object representing an OpenTok SIP call.

SipProperties - Class in com.opentok

Defines values for the properties parameter of the OpenTok.dial(String, String, SipProperties) method.

SipProperties.Builder - Class in com.opentok

Use this class to create a SipProperties object.

sipUri(String) - Method in class com.opentok.SipProperties.Builder

Call this method to set the SIP URI.

sipUri() - Method in class com.opentok.SipProperties

Returns the SIP URI.

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

startBroadcast(String, BroadcastProperties) - Method in class com.opentok.OpenTok

Starts a live streaming broadcast for an OpenTok session.

startCaptions(String, String, CaptionProperties) - Method in class com.opentok.OpenTok

Use the Live Captions API to transcribe audio streams and generate real-time captions for your application.

startRender(String, String, RenderProperties) - Method in class com.opentok.OpenTok

Starts an Experience Composer render for an OpenTok session.

statusCallbackUrl(String) - Method in class com.opentok.CaptionProperties.Builder

A publicly reachable URL controlled by the customer and capable of generating the content to be rendered without user intervention.

stopArchive(String) - Method in class com.opentok.OpenTok

Stops an OpenTok archive that is being recorded.

stopBroadcast(String) - Method in class com.opentok.OpenTok

Stops a live streaming broadcast of an OpenTok session.

stopCaptions(String) - Method in class com.opentok.OpenTok

Use this method to stop live captions for a session.

stopRender(String) - Method in class com.opentok.OpenTok

Stops an Experience Composer of an OpenTok session.

Stream - Class in com.opentok

Represents a stream in an OpenTok session.

StreamList - Class in com.opentok

Represents a list of OpenTok Streams.

StreamList() - Constructor for class com.opentok.StreamList

StreamListProperties - Class in com.opentok

Defines values for the properties parameter of the OpenTok.setStreamLayouts(String, StreamListProperties) method.

StreamListProperties.Builder - Class in com.opentok

Use this class to create a StreamListProperties object.

streamMode(Archive.StreamMode) - Method in class com.opentok.ArchiveProperties.Builder

Sets the stream mode for this archive.

streamMode() - Method in class com.opentok.ArchiveProperties

The stream mode of the archive.

streamMode(Broadcast.StreamMode) - Method in class com.opentok.BroadcastProperties.Builder

Sets the stream mode for this broadcast When streams are selected automatically (StreamMode.AUTO, the default), all streams in the session can be included in the archive.

streamMode() - Method in class com.opentok.BroadcastProperties

The stream mode of the broadcast.

streamName(String) - Method in class com.opentok.RtmpProperties.Builder

Call this method to set the stream name, such as the YouTube Live stream name or the Facebook stream key.

streamName() - Method in class com.opentok.RtmpProperties

Returns the stream name of the broadcast, such as the YouTube Live stream name or the Facebook stream key.

StreamProperties - Class in com.opentok

Defines values for the properties parameter of the OpenTok.setStreamLayouts(String, StreamListProperties) method.

StreamProperties.Builder - Class in com.opentok

Use this class to create a StreamProperties object.

streams() - Method in class com.opentok.AudioConnectorProperties

(OPTIONAL) A collection of stream IDs for the OpenTok streams included in the WebSocket audio.

streams(String...) - Method in class com.opentok.SipProperties.Builder

The stream IDs of the participants' which will be subscribed by the SIP participant.

streams() - Method in class com.opentok.SipProperties

Returns the subscribed stream IDs.

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.

toMap() - Method in class com.opentok.ArchiveProperties

Returns the archive properties as a Map.

toMap() - Method in class com.opentok.SessionProperties

Serializes the properties for making a request.

toMap() - Method in class com.opentok.SignalProperties

Returns the signal properties as a Map.

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

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

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

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

toString() - Method in enum com.opentok.ArchiveLayout.Type

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

toString() - Method in enum com.opentok.Broadcast.StreamMode

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

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

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

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

toString() - Method in enum com.opentok.RenderProperties.Resolution

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

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

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

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

type() - Method in class com.opentok.AudioConnectorProperties

Returns the name of the JSON object for the connection request body.

type(String) - Method in class com.opentok.SignalProperties.Builder

Call this method to set a type of the signal.

type() - Method in class com.opentok.SignalProperties

Returns the type of the signal

U

uri() - Method in class com.opentok.AudioConnectorProperties

The WebSocket URI to be used for the destination of the audio stream.

url(String) - Method in class com.opentok.RenderProperties.Builder

URL of the customer service where the callbacks will be received.

url(URI) - Method in class com.opentok.RenderProperties.Builder

URL of the customer service where the callbacks will be received.

url() - Method in class com.opentok.RenderProperties

userName(String) - Method in class com.opentok.SipProperties.Builder

Call this method to set the username for the SIP gateway provider (optional).

userName() - Method in class com.opentok.SipProperties

Returns the user name.

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.Archive.StreamMode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.opentok.ArchiveLayout.Type

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.Broadcast.StreamMode

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.RenderProperties.Resolution

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.opentok.RenderStatus

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.opentok.Resolution

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.

valueOf(String) - Static method in enum com.opentok.ScreenShareLayoutType

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.Archive.StreamMode

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

values() - Static method in enum com.opentok.ArchiveLayout.Type

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.Broadcast.StreamMode

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.RenderProperties.Resolution

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

values() - Static method in enum com.opentok.RenderStatus

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

values() - Static method in enum com.opentok.Resolution

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.

values() - Static method in enum com.opentok.ScreenShareLayoutType

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

video(boolean) - Method in class com.opentok.SipProperties.Builder

Call this method and pass in true to enable video in the SIP call.

video() - Method in class com.opentok.SipProperties

Return the video value (true or false).

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