Rate this page:

RealtimeTTSPlayerParameters

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

Props

apiKey

Copy URL
apiKey: 

string

|

undefined

Optional. Cartesia API key. Use your Cartesia API key if you have your own Cartesia account.

generationRequestParameters

Copy URL
generationRequestParameters: 

Object

Object to provide parameters directly to the Cartesia provider's Generation Request message. Find more information in the documentation.

trace

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