Suggestions

close search

Add Messaging, Voice, and Authentication to your apps with Vonage Communications APIs

Visit the Vonage API Developer Portal

OpenTokSDK.AudioConnectorStartRequest.WebSocket

Options for configuring the connect call for WebSocket. More...

Public Member Functions

 WebSocket (Uri uri, string[] streams=null, Dictionary< string, string > headers=null)
 Creates a new instance of WebSocket. More...

Properties

Uri Uri [get]
 A publicly reachable WebSocket URI controlled by the customer for the destination of the connect call. (f.e. wss://service.com/wsendpoint)" More...
string [] Streams [get]
 The stream IDs of the participants' whose audio is going to be connected. If not provided, all streams in session will be selected. More...
Dictionary< string, string > Headers [get]
 An object of key/val pairs with additional properties to send to your Websocket server, with a maximum length of 512 bytes. More...

Detailed Description

Options for configuring the connect call for WebSocket.

Constructor & Destructor Documentation

◆ WebSocket()

OpenTokSDK.AudioConnectorStartRequest.WebSocket.WebSocket ( Uri  uri,
string []  streams = null,
Dictionary< string, string >  headers = null 
)

Creates a new instance of WebSocket.

Parameters
uriA publicly reachable WebSocket URI controlled by the customer for the destination of the connect call. (f.e. wss://service.com/wsendpoint)".
streamsAn array of stream IDs for the OpenTok streams you want to include in the WebSocket stream. If you omit this property, all streams in the session will be included.
headersAn object of key-value pairs of headers to be sent to your WebSocket server with each message, with a maximum length of 512 bytes.

Property Documentation

◆ Headers

Dictionary<string, string> OpenTokSDK.AudioConnectorStartRequest.WebSocket.Headers

An object of key/val pairs with additional properties to send to your Websocket server, with a maximum length of 512 bytes.

◆ Streams

string [] OpenTokSDK.AudioConnectorStartRequest.WebSocket.Streams

The stream IDs of the participants' whose audio is going to be connected. If not provided, all streams in session will be selected.

◆ Uri

Uri OpenTokSDK.AudioConnectorStartRequest.WebSocket.Uri

A publicly reachable WebSocket URI controlled by the customer for the destination of the connect call. (f.e. wss://service.com/wsendpoint)"