Rate this page:

RealtimeTTSPlayerParameters

VoxTTS.RealtimeTTSPlayer parameters. Can be passed as arguments to the VoxTTS.createRealtimeTTSPlayer method.

Props

apiKey
Optional
Copy URL
apiKey: 

string

Optional. VoxTTS API key. Use your VoxTTS API key if you have your own.

createContextParameters
Copy URL
createContextParameters: 

CreateContextParameters

Object to provide parameters directly to the VoxTTS provider Create Context message.

trace
Optional
Copy URL
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.

Rate this page: