Class PiperTTS

High-level TypeScript wrapper around the Piper CLI.

Index

Methods

getBinaryPath getDefaultOptions getModelPath synthesize synthesizeToFile create

Methods

getBinaryPath

getBinaryPath(): string
Returns the resolved executable path used to run Piper.

Returns string
Absolute executable path.
- Defined in piper-tts.ts:391

getDefaultOptions

getDefaultOptions(): Readonly<PiperInferenceOptions>
Returns a copy of default inference options.

Returns Readonly<PiperInferenceOptions>
Read-only default inference options.
- Defined in piper-tts.ts:400

getModelPath

getModelPath(): string
Returns the resolved model path used by this instance.

Returns string
Absolute model path.
- Defined in piper-tts.ts:382

synthesize

synthesize(
text: string,
callOptions?: PiperInferenceOptions,
): Promise<SynthesisResult>
Synthesizes speech for the given text and returns audio as Buffer.
- outputFormat: "wav" (default): WAV bytes via a temp file (or directly to outputFile when set).
- outputFormat: "raw": raw PCM bytes captured from stdout.
- outputFormat: "mp3" | "ogg" | "opus": WAV internally, transcoded via ffmpeg (or pure-JS fallbacks: lamejs for mp3, opusscript for opus).
Parameters
- text: string
  Input text to synthesize.
- callOptions: PiperInferenceOptions = {}
  Optional inference options for this call.
Returns Promise<SynthesisResult>
Synthesis result with audio buffer and metadata.

Throws
When text is empty, options are invalid, or Piper fails.
- Defined in piper-tts.ts:262

synthesizeToFile

synthesizeToFile(
    text: string,
    outputPath: string,
    options?: Omit<PiperInferenceOptions, "outputFile">,
): Promise<void>
Convenience helper that synthesizes directly to a file.
Parameters
- text: string
  Input text to synthesize.
- outputPath: string
  Destination file path.
- options: Omit<PiperInferenceOptions, "outputFile"> = {}
  Optional inference options for this call.
Returns Promise<void>
Promise resolved when the output file has been written.
- Defined in piper-tts.ts:369

`Static`create

create(options: PiperTTSOptions): Promise<PiperTTS>
Creates a new instance and performs a warm-up inference to validate setup.

Pass skipWarmup: true to skip the validation inference.
Parameters
- options: PiperTTSOptions
  Instance creation options.
Returns Promise<PiperTTS>
A fully initialized PiperTTS instance.

Throws
When model resolution, binary resolution, or warm-up fails.
- Defined in piper-tts.ts:179