Interface TTSOptions

Configuration options for Rime AI TTS

interface TTSOptions {
    allowCustomEndpoint?: boolean;
    apiKey?: string;
    audioFormat?: RimeAudioFormat;
    baseURL?: string;
    inlineSpeedAlpha?: string;
    lang?: string;
    max_tokens?: number;
    modelId: string;
    noTextNormalization?: boolean;
    pauseBetweenBrackets?: boolean;
    phonemizeBetweenBrackets?: boolean;
    reduceLatency?: boolean;
    repetition_penalty?: number;
    samplingRate?: number;
    saveOovs?: boolean;
    segment?: string;
    speaker: string;
    speedAlpha?: number;
    temperature?: number;
    timeScaleFactor?: number;
    tokenizer?: tokenize.SentenceTokenizer;
    top_p?: number;
    useWebsocket?: boolean;
    websocketProtocol?: WebSocketProtocol;
    websocketURL?: string;
    [key: string]: string | number | boolean | tokenize.SentenceTokenizer | undefined;
}

Indexable

[key: string]: string | number | boolean | tokenize.SentenceTokenizer | undefined

Additional Rime API parameters

Properties

allowCustomEndpoint? apiKey? audioFormat? baseURL? inlineSpeedAlpha? lang? max_tokens? modelId noTextNormalization? pauseBetweenBrackets? phonemizeBetweenBrackets? reduceLatency? repetition_penalty? samplingRate? saveOovs? segment? speaker speedAlpha? temperature? timeScaleFactor? tokenizer? top_p? useWebsocket? websocketProtocol? websocketURL?

Properties

Optional allowCustomEndpoint

allowCustomEndpoint?: boolean

Allow sending the API key to a host outside rime.ai.

Optional apiKey

apiKey?: string

Optional audioFormat

audioFormat?: RimeAudioFormat

Optional baseURL

baseURL?: string

Optional inlineSpeedAlpha

inlineSpeedAlpha?: string

Optional lang

lang?: string

Optional max_tokens

max_tokens?: number

modelId

modelId: string

Required at construction when websocketURL is set. The plugin does not read the model from the URL.

Optional noTextNormalization

noTextNormalization?: boolean

Optional pauseBetweenBrackets

pauseBetweenBrackets?: boolean

Optional phonemizeBetweenBrackets

phonemizeBetweenBrackets?: boolean

Optional reduceLatency

reduceLatency?: boolean

Optional repetition_penalty

repetition_penalty?: number

Optional samplingRate

samplingRate?: number

Optional saveOovs

saveOovs?: boolean

Optional segment

segment?: string

speaker

speaker: string

Optional speedAlpha

speedAlpha?: number

Optional temperature

temperature?: number

Optional timeScaleFactor

timeScaleFactor?: number

Optional tokenizer

tokenizer?: tokenize.SentenceTokenizer

Optional top_p

top_p?: number

Optional useWebsocket

useWebsocket?: boolean

Optional websocketProtocol

websocketProtocol?: WebSocketProtocol

Optional websocketURL

websocketURL?: string

Explicit endpoint selects the Rime v1 streaming protocol.

Settings

Member Visibility

Theme

On This Page

allowCustomEndpointapiKeyaudioFormatbaseURLinlineSpeedAlphalangmax_tokensmodelIdnoTextNormalizationpauseBetweenBracketsphonemizeBetweenBracketsreduceLatencyrepetition_penaltysamplingRatesaveOovssegmentspeakerspeedAlphatemperaturetimeScaleFactortokenizertop_puseWebsocketwebsocketProtocolwebsocketURL