Interface TTSOptions

interface TTSOptions {
    apiKey?: string;
    applyLanguageTextNormalization?: boolean;
    applyTextNormalization?: "on" | "auto" | "off";
    autoMode?: boolean;
    baseURL?: string;
    chunkLengthSchedule?: number[];
    enableLogging?: boolean;
    enableSsmlParsing?: boolean;
    encoding?: TTSEncoding;
    inactivityTimeout?: number;
    language?: string;
    languageCode?: string;
    model?: string;
    modelID?: string;
    preferredAlignment?: "normalized" | "original";
    pronunciationDictionaryLocators?: PronunciationDictionaryLocator[];
    streamingLatency?: number;
    syncAlignment?: boolean;
    voice?: Voice;
    voiceId?: string;
    voiceSettings?: VoiceSettings;
    wordTokenizer?: tokenize.WordTokenizer | tokenize.SentenceTokenizer;
}

Properties

apiKey? applyLanguageTextNormalization? applyTextNormalization? autoMode? baseURL? chunkLengthSchedule? enableLogging? enableSsmlParsing? encoding? inactivityTimeout? language? languageCode? model? modelID? preferredAlignment? pronunciationDictionaryLocators? streamingLatency? syncAlignment? voice? voiceId? voiceSettings? wordTokenizer?

Properties

Optional apiKey

apiKey?: string

Optional applyLanguageTextNormalization

applyLanguageTextNormalization?: boolean

Optional applyTextNormalization

applyTextNormalization?: "on" | "auto" | "off"

Optional autoMode

autoMode?: boolean

Optional baseURL

baseURL?: string

Optional chunkLengthSchedule

chunkLengthSchedule?: number[]

Optional enableLogging

enableLogging?: boolean

Optional enableSsmlParsing

enableSsmlParsing?: boolean

Optional encoding

encoding?: TTSEncoding

Optional inactivityTimeout

inactivityTimeout?: number

Optional language

language?: string

Language code used to enforce a language for the model and text normalization. If the model does not support language overrides, it will be ignored.

Optional languageCode

languageCode?: string

Optional model

model?: string

TTS model to use. Defaults to eleven_turbo_v2_5. eleven_v3, eleven_v3_conversational, eleven_v4 and eleven_v4_turbo go through ElevenLabs' text-to-dialogue API instead (single voice per instance, same as other models).

Optional modelID

modelID?: string

Optional preferredAlignment

preferredAlignment?: "normalized" | "original"

Optional pronunciationDictionaryLocators

pronunciationDictionaryLocators?: PronunciationDictionaryLocator[]

Optional streamingLatency

streamingLatency?: number

Optional syncAlignment

syncAlignment?: boolean

Optional voice

voice?: Voice

Optional voiceId

voiceId?: string

Optional voiceSettings

voiceSettings?: VoiceSettings

Optional wordTokenizer

wordTokenizer?: tokenize.WordTokenizer | tokenize.SentenceTokenizer

Settings

Member Visibility

Theme

On This Page

apiKeyapplyLanguageTextNormalizationapplyTextNormalizationautoModebaseURLchunkLengthScheduleenableLoggingenableSsmlParsingencodinginactivityTimeoutlanguagelanguageCodemodelmodelIDpreferredAlignmentpronunciationDictionaryLocatorsstreamingLatencysyncAlignmentvoicevoiceIdvoiceSettingswordTokenizer