Rate this page:

RealtimeTTSPlayerParameters

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

Props

headers

Copy URL
headers: 

RealtimeTTSPlayerHeader[]

Optional. HTTP request headers.

initializeConnectionParameters

Copy URL
initializeConnectionParameters: 

Object

Optional. Provide the parameters directly to the 'initializeConnection' method of ElevenLabs provider. Find more information in the documentation. Note: You should not pass the 'text', 'xi-api-key' and 'authorization' fields.

keepAlive

Copy URL
keepAlive: 

false

|

undefined

|

true

Optional. Whether to keep the connection alive after the timeout. The default value is true.

pathParameters

Copy URL
pathParameters: 

Object

Provide the parameters directly to the ElevenLabs provider. Find more information in the documentation.

queryParameters

Copy URL
queryParameters: 

Object

Provide the parameters directly to the ElevenLabs provider. 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 only for diagnostic purposes.