RealtimeTTSPlayer

Extends: BasePlayer

Methods

clearBuffer

Clears a Deepgram.RealtimeTTSPlayer buffer and resets the provider text/audio queue. Find more information in the documentation

clearBuffer(): void

flush

Forces the Deepgram provider to process all queued text and return the final audio immediately.

Sends { type: "Flush" } to the provider. Required when the text stream is finished but the WebSocket connection should remain open. Find more information in the documentation

flush(): void

sendText

Sends a text message to the Deepgram provider Speak WebSocket connection.

Use this to append text for continuous speech generation. Find more information in the documentation.

sendText(parameters: Object): void

Parameters

Inherited Methods

addEventListener

Inherited from BasePlayer.

Adds a handler for the specified PlayerEvents event. Use only functions as handlers; anything except a function leads to the error and scenario termination when a handler is called.

addEventListener(event: PlayerEvents | T, callback: (event: _PlayerEvents[T]) => any): void

Parameters

id

Inherited from BasePlayer.

Returns the player’s id.

id(): string

pause

Inherited from BasePlayer.

Pauses playback. To continue the playback use the Player.resume method.

pause(): void

removeEventListener

Inherited from BasePlayer.

Removes a handler for the specified PlayerEvents event.

removeEventListener(event: PlayerEvents | T, callback?: (event: _PlayerEvents[T]) => any): void

Parameters

resume

Inherited from BasePlayer.

Resumes playback after the Player.pause method is called.

resume(): void

sendMediaTo

Inherited from BasePlayer.

Starts sending media from the player to the media unit.

sendMediaTo(mediaUnit: VoxMediaUnit, parameters?: SendMediaParameters): void

Parameters

stop

Inherited from BasePlayer.

Stops playback. The current player’s instance is destroyed.

stop(): void

stopMediaTo

Inherited from BasePlayer.

Stops sending media from the player to the media unit.

stopMediaTo(mediaUnit: VoxMediaUnit): void

Parameters