Google

View as Markdown

Classes

Functions

createRealtimeTTSPlayer

Creates a new Google.RealtimeTTSPlayer instance. You can attach media streams later via the Google.RealtimeTTSPlayer.sendMediaTo or VoxEngine.sendMediaBetween methods.

1createRealtimeTTSPlayer(parameters?: RealtimeTTSPlayerParameters): RealtimeTTSPlayer

Parameters

parameters
RealtimeTTSPlayerParameters

Types

RealtimeTTSPlayerParameters

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

keepAlive
boolean

optional

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

language_code
string

BCP-47 language tag representing the voice language.

Specifies the locale used for speech synthesis, including language and optionally region.

Must be a valid BCP-47 tag (e.g., “en-US”,“en-GB”, “en-IN”, “de-DE”, “fr-FR”, “pl-PL”, “ru-RU”).

trace
boolean

optional

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.

voice
string

The name of the voice used for speech synthesis. Each voice has a unique identifier and represents a specific synthetic speaker with its own characteristics (e.g., gender, tone).

Find more information in the documentation(https://docs.cloud.google.com/text-to-speech/docs/list-voices-and-types).

Example voices include: “Aoede”, “Puck”, “Charon”, “Kore”, “Fenrir”, “Leda”, “Orus”, “Zephyr”.