Package com.opentok

Includes the main classes of the OpenTok Java SDK.

Class Summary

Class	Description
Archive	Represents an archive of an OpenTok session.
ArchiveLayout	Represents a layout configuration for a composed archive.
ArchiveList	Represents a list of archives of OpenTok session(s).
ArchiveProperties	Defines values for the properties parameter of the OpenTok.startArchive(String sessionId, ArchiveProperties properties) method.
ArchiveProperties.Builder	Used to create an ArchiveProperties object.
AudioConnector	Represents an Audio Connector instance.
AudioConnectorProperties	Defines values for the properties parameter of the OpenTok.connectAudioStream(String, String, AudioConnectorProperties) method.
AudioConnectorProperties.Builder	Intermediary stateful object used to construct AudioConnectorProperties.
Broadcast	Represents a live streaming broadcast of an OpenTok session.
BroadcastLayout	Represents a layout configuration for a live streaming broadcast.
BroadcastProperties	Defines values for the properties parameter of the OpenTok.startBroadcast(String sessionId, BroadcastProperties properties) method.
BroadcastProperties.Builder	Used to create a BroadcastProperties object.
Caption	Represents the response from OpenTok.startCaptions(String, String, CaptionProperties).
CaptionProperties	Defines values for the properties parameter of the OpenTok.startCaptions(String, String, CaptionProperties) method.
CaptionProperties.Builder	Used to create a CaptionProperties object.
CreatedSession	Used internally.
Hls	Represents HLS options for a live streaming broadcast.
Hls.Builder	Used to create the Hls object.
MuteAllProperties	Defines values for the properties parameter of the OpenTok.forceMuteAll(String, MuteAllProperties) method.
MuteAllProperties.Builder	Use this class to create a MuteAllProperties object.
OpenTok	Contains methods for creating OpenTok sessions, generating tokens, and working with archives.
OpenTok.Builder	Used to create an OpenTok object with advanced settings.
Render	Represents an Experience Composer element response.
RenderProperties	Defines values for the properties parameter of the OpenTok.startRender(String sessionId, String token, RenderProperties properties) method.
RenderProperties.Builder	Builder for defining the parameters of RenderProperties.
RenderProperties.Properties	Represents the properties parameter of RenderProperties.
Rtmp	Represents an RTMP stream in an OpenTok session.
RtmpProperties	Defines values for the RtmpProperties value of the BroadcastProperties parameter of the OpenTok.startBroadcast(String, BroadcastProperties)
RtmpProperties.Builder	Use this class to create a RtmpProperties object.
Session	Represents an OpenTok session.
SessionProperties	Defines values for the properties parameter of the OpenTok.createSession(SessionProperties) method.
SessionProperties.Builder	Use this class to create a SessionProperties object.
SignalProperties	Defines values for the properties parameter of the OpenTok.signal(String, SignalProperties) (String, String)} method.
SignalProperties.Builder	Use this class to create a SignalProperties object.
Sip	An object representing an OpenTok SIP call.
SipProperties	Defines values for the properties parameter of the OpenTok.dial(String, String, SipProperties) method.
SipProperties.Builder	Use this class to create a SipProperties object.
Stream	Represents a stream in an OpenTok session.
StreamList	Represents a list of OpenTok Streams.
StreamListProperties	Defines values for the properties parameter of the OpenTok.setStreamLayouts(String, StreamListProperties) method.
StreamListProperties.Builder	Use this class to create a StreamListProperties object.
StreamProperties	Defines values for the properties parameter of the OpenTok.setStreamLayouts(String, StreamListProperties) method.
StreamProperties.Builder	Use this class to create a StreamProperties object.
TokenOptions	Defines values for the tokenOptions parameter of the OpenTok.generateToken(String sessionId, TokenOptions tokenOptions) method and the Session.generateToken(TokenOptions tokenOptions) method.
TokenOptions.Builder	Use this class to create a TokenOptions object.

Enum Summary

Enum	Description
Archive.OutputMode	Defines values used in the ArchiveProperties.Builder.outputMode(com.opentok.Archive.OutputMode) method and returned by the Archive.getOutputMode() method.
Archive.Status	Defines values returned by the Archive.getStatus() method.
Archive.StreamMode	Defines values used in the ArchiveProperties.Builder.streamMode(com.opentok.Archive.StreamMode) method and returned by the Archive.getStreamMode() method.
ArchiveLayout.Type	Enumerates type values for the layout.
ArchiveMode	Defines values for the archiveMode parameter of the SessionProperties.Builder.archiveMode(ArchiveMode archiveMode) method.
Broadcast.StreamMode	Defines values used in the BroadcastProperties.Builder.streamMode(com.opentok.Broadcast.StreamMode) method and returned by the Broadcast.getStreamMode() method.
MediaMode	Defines values for the mediaMode parameter of the SessionProperties.Builder.mediaMode(MediaMode mediaMode) method.
RenderProperties.Resolution	Represents the resolution parameter of RenderProperties.
RenderStatus	Enum representing the status of a Render.
Resolution	Defines valid video resolutions.
Role	Defines values for the role parameter of the role(Role role) method.
ScreenShareLayoutType	Enumerates type values for the layout.