Package com.vonage.client.video

Class Websocket

java.lang.Object

com.vonage.client.JsonableBaseObject

com.vonage.client.video.Websocket

All Implemented Interfaces:

Jsonable

public final class Websocket
extends JsonableBaseObject

Defines the properties in ConnectRequest.getWebsocket().

Since:

8.5.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Websocket.AudioRate	Represents the possible audio sampling rate values for a WebSocket connection.

Method Summary

Modifier and Type	Method	Description
Websocket.AudioRate	getAudioRate()	Audio sampling rate in Hz.
Map<String,String>	getHeaders()	Headers to be sent to your WebSocket server with each message, with a maximum length of 512 bytes.
Collection<String>	getStreams()	Stream IDs for the Vonage Video streams you want to include in the WebSocket audio.
URI	getUri()	A publicly reachable WebSocket URI to be used for the destination of the audio stream.

Methods inherited from class com.vonage.client.JsonableBaseObject

createJsonObjectMapper, equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.vonage.client.Jsonable

toJson, updateFromJson

Method Details

getUri

public URI getUri()

A publicly reachable WebSocket URI to be used for the destination of the audio stream.

Returns:

The WebSocket URI.

getStreams

public Collection<String> getStreams()

Stream IDs for the Vonage Video streams you want to include in the WebSocket audio. If you omitted, all streams in the session will be included.

Returns:

The collection of stream IDs to include, or null if not specified.

getHeaders

public Map<String,String> getHeaders()

Headers to be sent to your WebSocket server with each message, with a maximum length of 512 bytes.

Returns:

The header key-value pairs as a Map, or null if not specified.

getAudioRate

public Websocket.AudioRate getAudioRate()

Audio sampling rate in Hz.

Returns:

The sample rate as an enum, or null if not specified.