Interface TTSOptions

interface TTSOptions {
    customPronunciations?: CustomPronunciations;
    instructions?: string;
    location?: string;
    model: string;
    project?: string;
    speaker?: string;
    speakers?: Record<string, string>;
    vertexai: boolean;
    voiceName: string;
}

Properties

customPronunciations? instructions? location? model project? speaker? speakers? vertexai voiceName

Properties

Optional customPronunciations

customPronunciations?: CustomPronunciations

Optional instructions

instructions?: string

Optional location

location?: string

model

model: string

Optional project

project?: string

Optional speaker

speaker?: string

Which of speakers this instance voices. Required with speakers, and switchable via updateOptions.

Optional speakers

speakers?: Record<string, string>

Speaker name to voice, for a multi-speaker voice config. Replaces voiceName. Needs a model that takes per-part speech metadata (the gemini-3.8 family).

vertexai

vertexai: boolean

voiceName

voiceName: string

Settings

Member Visibility

Theme

On This Page

customPronunciationsinstructionslocationmodelprojectspeakerspeakersvertexaivoiceName