Package com.vonage.client.video

package com.vonage.client.video

This package contains classes to support usage of the Video API.
This API is a rewrite of the OpenTok Java SDK. You can use VideoClient in a similar way to the OpenTok class in the OpenTok Java SDK, although some method and class names may differ slightly, as they have been rewritten to be consistent with the rest of this SDK. See OPENTOK_TO_VONAGE_MIGRATION.md for details.
Learn more about the Video API and how to use this SDK from the Vonage Developer Portal.

Since:

8.0.0-beta1

Related Packages

Package	Description
com.vonage.client	The root of the Vonage client library, containing VonageClient class, which is probably what you want.

Class	Description
Archive	Represents an archive of a video session.
Archive.Builder	Used to construct an Archive object.
ArchiveMode	Defines values for the archiveMode parameter of the CreateSessionRequest.Builder.archiveMode(ArchiveMode archiveMode) method.
ArchiveStatus	Defines values returned by the Archive.getStatus() method.
Broadcast	Represents properties of a live-streaming broadcast.
Broadcast.Builder	Used to construct a Broadcast object.
BroadcastStatus	Defines values returned by the Broadcast.getStatus() method.
BroadcastUrls	Container for details about the HLS and RTMP broadcasts.
CaptionsRequest	Defines the captioning properties used in VideoClient.startCaptions(CaptionsRequest).
CaptionsRequest.Builder	Builder for defining the fields in a StartCaptionsRequest object.
CaptionsResponse	Represents the response from VideoClient.startCaptions(CaptionsRequest).
ConnectRequest	Defines properties used for Audio Connector.
ConnectRequest.Builder	Builder for defining the fields in a ConnectRequest object.
ConnectResponse	Represents the response from VideoClient.startCaptions(CaptionsRequest).
CreateSessionRequest	Defines the properties used to create a new video session.
CreateSessionRequest.Builder	Builder for constructing CreateSessionRequest.
CreateSessionResponse
GetStreamResponse	Represents details of a stream, as returned from VideoClient.getStream(String, String).
Hls	Represents HTTP Live Streaming (HLS) options for a Broadcast.
Hls.Builder	Used to create the Hls object.
Language	Represents the supported BCP-47 language codes for Live Captions.
ListStreamCompositionsRequest	Filter properties and pagination for VideoClient.listArchives(ListStreamCompositionsRequest) and VideoClient.listBroadcasts(ListStreamCompositionsRequest).
ListStreamCompositionsRequest.Builder
MediaMode	Defines values for the mediaMode parameter of the CreateSessionRequest.Builder.mediaMode(MediaMode mediaMode) method.
OutputMode	Defines values used in the Archive.Builder.outputMode(OutputMode) method and returned by the Archive.getOutputMode() method.
ProjectDetails	Represents properties of a video project.
ProjectEnvironment	Represents the project environment type.
ProjectStatus	Represents the project status.
RenderRequest	Defines the parameters for starting an Experience Composer session.
RenderRequest.Builder	Builder for defining the parameters of RenderRequest.
RenderRequest.Properties	Publisher initial configuration properties for the composed output stream.
RenderResponse	Represents an Experience Composer response.
RenderStatus	Represents the possible states in RenderResponse.getStatus().
Resolution	Defines valid video resolutions for an archive.
Role	Defines values for the role parameter of the TokenOptions.Builder.role(Role role) method.
Rtmp	Represents an RTMP stream in a video session.
Rtmp.Builder
RtmpStatus	Represents the status of an RTMP stream.
ScreenLayoutType	Represents the available layout types for archives in StreamCompositionLayout.
SessionStream	Represents a stream's metadata in a Vonage Video session.
SessionStream.Builder
SignalRequest
SignalRequest.Builder
SipDialRequest	Represents an outbound SIP dial request's properties.
SipDialRequest.Builder	Used to create an SipDialRequest object.
SipDialResponse	Represents a Vonage Video SIP call.
StreamComposition	Base class for Broadcast and Archive.
StreamComposition.Builder
StreamCompositionLayout	Defines the properties used for VideoClient.updateArchiveLayout(String, StreamCompositionLayout).
StreamCompositionLayout.Builder
StreamMode	Defines values for how streams will be selected for broadcasts and archives.
TokenOptions	Defines values for the options parameter of the VideoClient.generateToken(String sessionId, TokenOptions tokenOptions) method.
TokenOptions.Builder	Use this class to create a TokenOptions object.
VideoClient	A client for using the Vonage Video API.
VideoResponseException	Response returned when an error is encountered (i.e. the API returns a non-2xx status code).
VideoStream
VideoType	Represents the video types returned in GetStreamResponse.getVideoType().
Websocket	Defines the properties in ConnectRequest.getWebsocket().
Websocket.AudioRate	Represents the possible audio sampling rate values for a WebSocket connection.