1. References
  2. VoxEngine
  3. VoxEngine
  4. createWebSocket
Rate this page:

createWebSocket

Copy URL
createWebSocket(url: 
string
, protocols: 
string
 | 
string[]
): 
WebSocket

Creates a WebSocket object. Sources can later be attached using the Call.sendMediaTo method. Add the following line to your scenario code to use the function:

require(Modules.WebSocket);

Parameters

  • url:

    string

    URL to which to connect (wss:// + domain + path).

  • protocols:

    string

    Either a single protocol string or an array of protocol strings. The default value is 'chat'.

Returns