Class TTSv2

Deepgram Flux TTS (the /v2/speak endpoint).

Sits alongside TTS, the Aura client for /v1/speak; this class does not replace it. Both the streaming (TTSv2.stream) and batch (TTSv2.synthesize) paths emit linear16 only — Deepgram also offers mp3/opus/flac/aac, but the LiveKit pipeline plays raw PCM and this plugin ships no decoder, so any other encoding is rejected.

Example

import { TTSv2 } from '@livekit/agents-plugin-deepgram';

const tts = new TTSv2({ model: 'flux-alexis-en' });

Hierarchy (view full)

tts.TTS
- TTSv2

Index

Constructors

constructor

new TTSv2(opts?): TTSv2
Parameters
- opts: Partial<TTSv2Options> = {}
Returns TTSv2
Overrides TTS.constructor
- Defined in plugins/deepgram/src/tts_v2.ts:150

Properties

label

label: string = 'deepgram.TTSv2'

Accessors

capabilities

get capabilities(): TTSCapabilities
Returns this TTS's capabilities

Returns TTSCapabilities
Inherited from tts.TTS.capabilities
- Defined in agents/dist/tts/tts.d.ts:144

markup

get markup(): TTSMarkup
Access TTS markup capabilities (instructions for the LLM, text conversion).

Returns TTSMarkup
Inherited from tts.TTS.markup
- Defined in agents/dist/tts/tts.d.ts:128

model

get model(): string
Get the model name/identifier for this TTS instance.

Returns string
The model name if available, "unknown" otherwise.

Remarks
Plugins should override this property to provide their model information.
Overrides tts.TTS.model
- Defined in plugins/deepgram/src/tts_v2.ts:138

numChannels

get numChannels(): number
Returns the channel count of audio frames returned by this TTS

Returns number
Inherited from tts.TTS.numChannels
- Defined in agents/dist/tts/tts.d.ts:148

provider

get provider(): string
Get the provider name for this TTS instance.

Returns string
The provider name if available, "unknown" otherwise.

Remarks
Plugins should override this property to provide their provider information.
Overrides tts.TTS.provider
- Defined in plugins/deepgram/src/tts_v2.ts:142

sampleRate

get sampleRate(): number
Returns the sample rate of audio frames returned by this TTS

Returns number
Overrides tts.TTS.sampleRate
- Defined in plugins/deepgram/src/tts_v2.ts:146

Methods

close

close(): Promise<void>
Returns Promise<void>
Overrides TTS.close
- Defined in plugins/deepgram/src/tts_v2.ts:213

prewarm

prewarm(): void
Open the pooled WebSocket ahead of the first generation so the first turn does not pay the connect. Safe to call more than once.

Returns void
Overrides TTS.prewarm
- Defined in plugins/deepgram/src/tts_v2.ts:204

releaseIdleConnections

releaseIdleConnections(): Promise<void>
Release pooled connections; an in-flight synthesis keeps its until it finishes.

Returns Promise<void>
Overrides TTS.releaseIdleConnections
- Defined in plugins/deepgram/src/tts_v2.ts:209

stream

stream(options?): tts.SynthesizeStream
Returns a SynthesizeStream that can be used to push text and receive audio data
Parameters
- Optional options: {
  connOptions?: APIConnectOptions;
  }
  Optional configuration including connection options
  - Optional connOptions?: APIConnectOptions
Returns tts.SynthesizeStream
Overrides TTS.stream
- Defined in plugins/deepgram/src/tts_v2.ts:196

synthesize

synthesize(text, connOptions?, abortSignal?): tts.ChunkedStream
Receives text and returns synthesis in the form of a ChunkedStream
Parameters
- text: string
- Optional connOptions: APIConnectOptions
- Optional abortSignal: AbortSignal
Returns tts.ChunkedStream
Overrides TTS.synthesize
- Defined in plugins/deepgram/src/tts_v2.ts:188

updateOptions

updateOptions(opts): void
Parameters
- opts: Partial<Pick<TTSv2Options, "model" | "sampleRate" | "encoding">>
Returns void
- Defined in plugins/deepgram/src/tts_v2.ts:173

Class TTSv2

Example

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns TTSv2

Properties

label

Accessors

capabilities

Returns TTSCapabilities

markup

Returns TTSMarkup

model

Returns string

Remarks

numChannels

Returns number

provider

Returns string

Remarks

sampleRate

Returns number

Methods

close

Returns Promise<void>

prewarm

Returns void

releaseIdleConnections

Returns Promise<void>

stream

Parameters

Optional connOptions?: APIConnectOptions

Returns tts.SynthesizeStream

synthesize

Parameters

Returns tts.ChunkedStream

updateOptions

Parameters

Returns void

Settings

Member Visibility

Theme

On This Page

`Optional` connOptions?: APIConnectOptions