Interface: TTSOptions<TProviderOptions>#

Defined in: packages/typescript/ai/src/types.ts:1550

Options for text-to-speech generation. These are the common options supported across providers.

Type Parameters#

TProviderOptions#

TProviderOptions extends object = object

Properties#

format?#

optional format: "mp3" | "opus" | "aac" | "flac" | "wav" | "pcm";

optional format: "mp3" | "opus" | "aac" | "flac" | "wav" | "pcm";

Defined in: packages/typescript/ai/src/types.ts:1558

The output audio format

logger#

logger: InternalLogger;

logger: InternalLogger;

Defined in: packages/typescript/ai/src/types.ts:1568

Internal logger threaded from the generateSpeech() entry point. Adapters must call logger.request() before the SDK call and logger.errors() in catch blocks.

model#

model: string;

model: string;

Defined in: packages/typescript/ai/src/types.ts:1552

The model to use for TTS generation

modelOptions?#

optional modelOptions: TProviderOptions;

optional modelOptions: TProviderOptions;

Defined in: packages/typescript/ai/src/types.ts:1562

Model-specific options for TTS generation

speed?#

optional speed: number;

optional speed: number;

Defined in: packages/typescript/ai/src/types.ts:1560

The speed of the generated audio (0.25 to 4.0)

text#

text: string;

text: string;

Defined in: packages/typescript/ai/src/types.ts:1554

The text to convert to speech

voice?#

optional voice: string;

optional voice: string;

Defined in: packages/typescript/ai/src/types.ts:1556

The voice to use for generation