pipertts - v1.3.0
    Preparing search index...

    Interface NativeTtsOptions

    Load options for PiperNativeTTS: model sources, session reuse, phonemizer data.

    interface NativeTtsOptions {
        configPath?: string;
        configUrl?: string;
        espeakBinary?: string;
        g2pwModelDir?: string;
        lithuanianDataDir?: string;
        model?: string;
        modelPath?: string;
        modelsDir?: string;
        modelUrl?: string;
        nakdimonModelPath?: string;
        nativeDataDir?: string;
        numThreads?: number;
        session?: NativeSession;
        tashkeelModelDir?: string;
        taskeenThreshold?: number;
        tltkDataDir?: string;
        unidicDir?: string;
        useTashkeel?: boolean;
    }
    Index
    configPath? configUrl? espeakBinary? g2pwModelDir? lithuanianDataDir? model? modelPath? modelsDir? modelUrl? nakdimonModelPath? nativeDataDir? numThreads? session? tashkeelModelDir? taskeenThreshold? tltkDataDir? unidicDir? useTashkeel?
    configPath?: string
    configUrl?: string

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

    espeakBinary?: string
    g2pwModelDir?: string

    Explicit g2pw model dir (skips download).

    lithuanianDataDir?: string

    Explicit Lithuanian data dir with lt_*.tsv (skips download).

    model?: string

    Catalog reference: rhasspy id/alias, hub:<slug>, piperhub.org page URL, or bare PiperHub slug. Ignored when modelPath / modelUrl is set.

    modelPath?: string

    Local .onnx model file path. Takes precedence over modelUrl / model.

    modelsDir?: string

    Directory used for downloaded models. Default: "models".

    modelUrl?: string

    Direct URL to a .onnx model file (any host, including Hugging Face). Downloaded once into modelsDir, then cached.

    nakdimonModelPath?: string

    Explicit Nakdimon model path or dir (skips download).

    nativeDataDir?: string

    Base dir for auto-downloaded phonemizer data (tashkeel/hebrew/lithuanian).

    numThreads?: number
    session?: NativeSession
    tashkeelModelDir?: string

    Explicit tashkeel model dir (skips download).

    taskeenThreshold?: number

    Logit threshold for taskeen, mirrors PiperVoice (default: 0.8).

    tltkDataDir?: string

    Explicit TLTK data dir (skips download).

    unidicDir?: string

    Explicit UniDic data dir (skips download).

    useTashkeel?: boolean

    Enable Arabic diacritization for ar voices (default: true).

    Settings
    Member Visibility

    On This Page
    Properties