RealtimeTTSPlayerParameters
Deepgram.RealtimeTTSPlayer parameters. Can be passed as arguments to the Deepgram.createRealtimeTTSPlayer method.
Props
apiKey: string
Optional. Deepgram API key. Use your Deepgram API key if you have your own Deepgram account.
generationRequestParameters: Object
Optional. Object to provide parameters directly to the Deepgram provider Speak WebSocket connection. Find more information in the documentation.
Supported fields:
- model — required. One of the available Deepgram TTS models (model + voice + language). See the TTS models list.
- language — optional. Language code when it is not already encoded in model.
- speed — optional. Speech speed from 0.7 to 1.5. Default is 1. Not supported for all languages.
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.