Skip to content
1 min read · 189 words

Interface: BaseTtsAdapterOptions

Defined in: src/batteries/tts/_shared/index.ts:51

Options shared by every TTS engine, regardless of backend.

Remarks

Engine-specific option interfaces extend this with their own transport/engine fields (and, for model-backed engines, a required model). Both fields are normalized per-engine:

  • voicesay -v <voice> / espeak-ng -v <voice> / PowerShell SelectVoice(<voice>) / transformers.js speaker_embeddings when it is a string.
  • rate is a multiplier where 1 is engine-normal, mapped per engine: round(175 * rate) words-per-minute for say/espeak-ng (clamped to a validated band), the documented -10..10SpeechSynthesizer.Rate for PowerShell, and speed for transformers.js.

Extended by

Properties

PropertyTypeDescriptionDefined in
rate?numberDefault speaking-rate multiplier (1 = engine-normal), applied when a synthesize call omits its own rate. Per-engine mapping (see the module remarks). Unset → engine-normal rate.src/batteries/tts/_shared/index.ts:61
voice?stringDefault voice, applied when a synthesize call omits its own voice. Per-engine semantics (see the module remarks). Unset → the engine/model default voice.src/batteries/tts/_shared/index.ts:56