RealtimeTTSPlayerParameters
XAI.RealtimeTTSPlayer parameters. Can be passed as arguments to the XAI.createRealtimeTTSPlayer method.
Props
apiKey: string
Optional. xAI API key. Use your xAI API key if you have your own xAI account.
connectionParameters: Object
Optional. Object to provide parameters for the xAI WebSocket connection. Must contain voice and language. Find more information in the documentation.
privacy: boolean
Optional. Whether to enable the privacy functionality.
If privacy is enabled, the logging for the WebSocket connection is disabled.
NOTE: the default value is false.
statistics: boolean
Optional. Enables statistics functionality.
trace: boolean
Optional. Whether to enable the tracing functionality.
If tracing is enabled, a 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 investigate issues.