Skip to content

Reference

Add emotion to any synthesis call. The compiler translates emotions into prosody parameters that are baked into the ControlGraph.

result = engine.speak("I'm so happy!", emotion="excited")
result = engine.speak("That's terrible.", emotion="sad")
result = engine.speak("Watch out!", emotion="urgent")

List all available emotions:

Terminal window
voice-soundboard emotions

Styles let you describe the voice quality in plain English. The compiler interprets these and maps them to prosody adjustments.

result = engine.speak("Good morning!", style="warmly and cheerfully")
result = engine.speak("The market dropped.", style="serious and measured")

Presets bundle voice + emotion + style + speed into a single name.

result = engine.speak("Breaking news!", preset="announcer")
result = engine.speak("Once upon a time...", preset="storyteller")

List all available presets:

Terminal window
voice-soundboard presets

The public API is unchanged across all major versions:

# This works in v1, v2, and v3
from voice_soundboard import VoiceEngine
engine = VoiceEngine()
result = engine.speak("Hello!", voice="af_bella", emotion="happy")

v3 removes 11 speculative modules that shipped with zero test coverage (distributed, serverless, intelligence, analytics, monitoring, security, ambiance, scenes, spatial, mcp, v3-alpha). The public API is unchanged. If you imported removed internals, see the CHANGELOG for details.

If you imported internal modules, use this migration mapping:

v1v2+
engine.pyadapters/api.py
emotions.pycompiler/emotion.py
interpreter.pycompiler/style.py
engines/kokoro.pyengine/backends/kokoro.py
  • Data accessed: Reads text input for TTS synthesis. Processes audio through configured backends (Kokoro, Piper, or mock). Returns PCM audio as numpy arrays or WAV files.
  • Data NOT accessed: No network egress by default (backends are local). No telemetry, analytics, or tracking. No user data storage beyond transient audio buffers.
  • Permissions required: Read access to TTS model files. Optional write access for audio output.

See SECURITY.md for vulnerability reporting.

Terminal window
pip install voice-soundboard