GeneratedVoice

Defined in: packages/ai/src/types.ts:3104

A single voice produced by VoiceGenerationOptions.

Properties#

audio?#

optional audio?: string;

Defined in: packages/ai/src/types.ts:3111

Base64-encoded preview audio, when the provider returns one

contentType?#

optional contentType?: string;

Defined in: packages/ai/src/types.ts:3115

Content type of the preview (e.g. 'audio/mpeg')

duration?#

optional duration?: number;

Defined in: packages/ai/src/types.ts:3117

Duration of the preview in seconds, if available

format?#

optional format?: string;

Defined in: packages/ai/src/types.ts:3113

Audio format of the preview (e.g. 'mp3')

language?#

optional language?: string;

Defined in: packages/ai/src/types.ts:3119

Language of the preview, if reported

saved#

saved: boolean;

Defined in: packages/ai/src/types.ts:3124

Whether the voice is persisted in the provider's voice library. Unsaved voices are previews and generally expire.

status#

status: VoiceTrainingStatus;

Defined in: packages/ai/src/types.ts:3129

Whether the voice can be used in generateSpeech() yet. Required so a caller never has to guess: every adapter states it outright.

voiceId#

voiceId: string;

Defined in: packages/ai/src/types.ts:3109

The provider's voice identifier. Pass it straight back as the voice option on generateSpeech().