Rate this page:

WebSocketParameters

WebSocket parameters. Can be passed as arguments to the VoxEngine.createWebSocket method.

Props

headers

Copy URL
headers: 

{name: string, value: string}[]

Optional. List of dictionaries with key and value fields representing headers.

protocols

Copy URL
protocols: 

string

|

string[]

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

statistics

Copy URL
statistics: 

false

|

undefined

|

true

Optional. Enables statistics functionality.

trace

Copy URL
trace: 

false

|

undefined

|

true

Optional. Enables trace functionality.