VoiceInfo interface

Voice metadata descriptor returned by TextToSpeech.listVoices().

Signature:

export declare interface VoiceInfo 

Properties

Property Type Description
displayName string Human-readable display name for the voice.
isDownloaded boolean Whether the voice embedding is bundled and ready for offline use.
locale string BCP-47 locale tag for the voice (e.g. "en-US", "en-GB", "ja-JP").
sampleRateHz number Output PCM audio sample rate in Hz (e.g. 24000).
voiceId string Unique voice identifier (e.g. "af_heart", "bf_emma", "jf_alpha").

VoiceInfo.displayName

Human-readable display name for the voice.

Signature:

displayName: string;

VoiceInfo.isDownloaded

Whether the voice embedding is bundled and ready for offline use.

Signature:

isDownloaded: boolean;

VoiceInfo.locale

BCP-47 locale tag for the voice (e.g. "en-US", "en-GB", "ja-JP").

Signature:

locale: string;

VoiceInfo.sampleRateHz

Output PCM audio sample rate in Hz (e.g. 24000).

Signature:

sampleRateHz: number;

VoiceInfo.voiceId

Unique voice identifier (e.g. "af_heart", "bf_emma", "jf_alpha").

Signature:

voiceId: string;