Rate this page:

RealtimeTTSPlayerParameters

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

Props

apiKey: string | undefined

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

createContextParameters: Object

Optional. Object to provide parameters directly to the Inworld provider Create Context message. Find more information in the documentation.

trace: false | undefined | true

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.