pipertts - v1.3.0
    Preparing search index...

    Interface PiperTTSOptions

    Constructor options for PiperTTS.

    interface PiperTTSOptions {
        configUrl?: string;
        defaultOptions?: Omit<PiperInferenceOptions, "modelPath">;
        model?: string;
        modelPath?: string;
        modelsDir?: string;
        modelUrl?: string;
        piperBinaryPath?: string;
        skipWarmup?: boolean;
        synthesisTimeoutMs?: number;
        warmUpText?: string;
    }
    Index
    configUrl? defaultOptions? model? modelPath? modelsDir? modelUrl? piperBinaryPath? skipWarmup? synthesisTimeoutMs? warmUpText?
    configUrl?: string

    Direct URL to the .onnx.json config. Defaults to <modelUrl>.json (Piper file convention).

    defaultOptions?: Omit<PiperInferenceOptions, "modelPath">

    Default options merged into every synthesis call.

    model?: string

    Model selector.

    • Rhasspy catalog id/alias: auto-downloads model files into modelsDir.
    • PiperHub voice: hub:<slug>, full piperhub.org/model/<slug>/ page URL, or bare slug (for example, "hub:glados-french-medium-voice").
    • "custom": use modelPath / modelUrl.
    modelPath?: string

    Path to the .onnx model when using custom/local mode.

    modelsDir?: string

    Directory used for auto-downloaded models (catalog, PiperHub, URL cache).

    modelUrl?: string

    Direct URL to a .onnx model file (any host, including Hugging Face). Downloaded once into modelsDir, then cached. Takes precedence over model, but not over an explicit local modelPath.

    piperBinaryPath?: string

    Optional explicit executable path or command name.

    skipWarmup?: boolean

    Skip the warm-up inference during create(). Default: false.

    synthesisTimeoutMs?: number

    Default synthesis timeout in ms applied when a call omits timeoutMs.

    warmUpText?: string

    Warm-up text used during startup validation.

    Settings
    Member Visibility

    On This Page
    Properties