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 : | | | | --- | --- | | uri | A publicly reachable WebSocket URI controlled by the customer for the destination of the connect call. (f.e. wss://service.com/wsendpoint)". | | streams | An 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. | | headers | An 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

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

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

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