WebSocketParameters
WebSocket parameters. Can be passed as arguments to the VoxEngine.createWebSocket method.
Props
headers
headers: {name: string, value: string}[]
Optional. List of dictionaries with key and value fields representing headers.
protocols
protocols: string
| string[]
Optional. Either a single protocol string or an array of protocol strings. The default value is chat.
statistics
statistics: false
| undefined
| true
Optional. Enables statistics functionality.
trace
trace: false
| undefined
| true
Optional. Whether to enable the tracing functionality. If tracing is enabled, an URL to the trace file appears in the websocket.created message. The file contains all sent and received WebSocket messages in the plain text format. The file is uploaded to the S3 storage.
Note: Enable this only for diagnostic purposes. You can provide the trace file to our support team to help investigating issues.