Interface FishAudioOptions

See https://docs.fish.audio/api-reference/endpoint/websocket/tts-live

interface FishAudioOptions {
    chunk_length?: number;
    condition_on_previous_chunks?: boolean;
    early_stop_threshold?: number;
    latency?: "low" | "balanced" | "normal";
    max_new_tokens?: number;
    min_chunk_length?: number;
    normalize?: boolean;
    normalize_loudness?: boolean;
    speed?: number;
    temperature?: number;
    top_p?: number;
    volume?: number;
}

Properties

chunk_length? condition_on_previous_chunks? early_stop_threshold? latency? max_new_tokens? min_chunk_length? normalize? normalize_loudness? speed? temperature? top_p? volume?

Properties

Optional chunk_length

chunk_length?: number

Characters buffered before auto-synthesis, range 100-300.

Optional condition_on_previous_chunks

condition_on_previous_chunks?: boolean

Use prior audio as context for consistency.

Optional early_stop_threshold

early_stop_threshold?: number

Early-stopping threshold for batching, range 0-1.

Optional latency

latency?: "low" | "balanced" | "normal"

Streaming latency mode.

Optional max_new_tokens

max_new_tokens?: number

Max audio tokens per text chunk, default 1024.

Optional min_chunk_length

min_chunk_length?: number

Min characters before splitting a new chunk, range 0-100.

Optional normalize

normalize?: boolean

Normalize numbers/dates/abbreviations before synthesis.

Optional normalize_loudness

normalize_loudness?: boolean

Consistent output loudness; S2-Pro family only.

Optional speed

speed?: number

Prosody speaking-rate multiplier, 1.0 is natural.

Optional temperature

temperature?: number

Range 0-1, higher is more varied/expressive.

Optional top_p

top_p?: number

Nucleus sampling probability mass, range 0-1.

Optional volume

volume?: number

Prosody loudness adjustment in dB, 0 is natural.

Settings

Member Visibility

Theme

On This Page

chunk_lengthcondition_on_previous_chunksearly_stop_thresholdlatencymax_new_tokensmin_chunk_lengthnormalizenormalize_loudnessspeedtemperaturetop_pvolume