XAI
Classes
Functions
createRealtimeTTSPlayer
Creates a new XAI.RealtimeTTSPlayer instance. You can attach media streams later via the XAI.RealtimeTTSPlayer.sendMediaTo or VoxEngine.sendMediaBetween methods.
Parameters
Types
RealtimeTTSPlayerParameters
Extends: _WebSocketBasedClientParameters
XAI.RealtimeTTSPlayer parameters. Can be passed as arguments to the XAI.createRealtimeTTSPlayer method.
optional
Optional. xAI API key. Use your xAI API key if you have your own xAI account.
optional
Optional. Object to provide parameters for the xAI WebSocket connection. Must contain voice and language. Find more information in the documentation.
Inherited fields
_optional, inherited from WebSocketBasedClientParameters
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.
_optional, inherited from WebSocketBasedClientParameters
Optional. Enables statistics functionality.
_optional, inherited from WebSocketBasedClientParameters
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 investigating issues.