VoiceInfo interface

Metadata about an available voice in the TTS model bundle.

Signature:

export declare interface VoiceInfo 

Properties

Property Type Description
displayName string Human-readable display name for the voice.
isDownloaded boolean Whether the voice assets are available in the loaded model bundle.
locale string BCP-47 locale tag for the voice (for example, 'en-US').
sampleRateHz number Native output sample rate in Hz for this voice.
voiceId string Unique identifier for the voice.

VoiceInfo.displayName

Human-readable display name for the voice.

Signature:

displayName: string;

VoiceInfo.isDownloaded

Whether the voice assets are available in the loaded model bundle.

Signature:

isDownloaded: boolean;

VoiceInfo.locale

BCP-47 locale tag for the voice (for example, 'en-US').

Signature:

locale: string;

VoiceInfo.sampleRateHz

Native output sample rate in Hz for this voice.

Signature:

sampleRateHz: number;

VoiceInfo.voiceId

Unique identifier for the voice.

Signature:

voiceId: string;