> Documentation index for agents: https://docs.rocketride.ai/llms.txt

# audio_tts

A RocketRide audio node that turns incoming text, documents, questions, or
answers into a WAV audio stream through Kokoro.

## About Kokoro

Kokoro is the text-to-speech backend used by this node. The node can construct
its pipeline locally or ask a configured model server to load the Kokoro
backend.

## What it does

The node synthesizes non-empty text and streams a `audio/wav` file on its
`audio` lane. Choose it when a pipeline needs to make text audible rather than
play already-produced media or turn speech into text. It extracts text from
the four supported input lanes, so it can speak data already moving through a
pipeline without an agent-tool interface.

## Lanes

| Lane in | Lane out | Description |
| --- | --- | --- |
| `text` | `audio` | Synthesize the supplied text. |
| `documents` | `audio` | Join eligible document `page_content` values with newlines, then synthesize it. |
| `questions` | `audio` | Join question text with spaces, then synthesize it. |
| `answers` | `audio` | Synthesize the answer text. |

## Configuration

Choose the single `kokoro` profile and its voice. Most users only need to
choose a voice appropriate for their text; the profile selector does not offer
an alternative backend.

### Voice

The voice is required at startup; a blank value raises `Kokoro: choose a voice
from the list`. Its first character is passed to the local or remote Kokoro
pipeline as the language code, so select a voice with the appropriate prefix
for the language you need. The default `af_heart` starts with `a`; change it
when the desired voice or its language-code prefix differs.

## Notes

### Local and model-server execution

When a model-server address is configured, the node connects a `ModelClient`,
loads the `kokoro` loader there, and writes the returned base64 WAV data to a
temporary file. Without one, it installs the local requirements, ensures the
`en_core_web_sm` spaCy model is present when spaCy is importable, and creates a
local `KPipeline`. Both paths synthesize at speed 1; the local path writes
mono, 16-bit, 24 kHz WAV output.

### Input and cleanup behavior

Whitespace-only input produces no audio. Document input excludes documents of
type `Image`, `Audio`, and `Video`; the remaining page content is joined with
newlines. A temporary WAV file is removed after streaming and is also removed
if synthesis raises an exception.

## Upstream docs

- [Kokoro repository](https://github.com/hexgrad/kokoro)

<!-- ROCKETRIDE:GENERATED:PARAMS START -->
<!-- Generated by nodes:docs-generate. Do not edit by hand. -->

## Schema

| Field | Type | Description | Default |
|---|---|---|---|
| `audio_tts.kokoro_voice` | `string` | **Voice**<br/>Kokoro voice. The language is derived automatically from the voice prefix (af_/am_ → American, bf_/bm_ → British, ef_/em_ → Spanish, etc.). | `"af_heart"` |
| `audio_tts.profile` | `string` | **TTS profile** | `"kokoro"` |

## Dependencies

- `numpy`
- `--only-binary` `docopt`
- `--only-binary` `num2words`
- `kokoro` `>=0.9.4`
- `soundfile` `>=0.13.1`

## Source

[<svg viewBox="0 0 16 16" width="15" height="15" fill="currentColor" aria-hidden="true" style="vertical-align:-0.15em;margin-right:0.35em"><path d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0016 8c0-4.42-3.58-8-8-8z"/></svg> View source](https://github.com/rocketride-org/rocketride-server/tree/develop/nodes/src/nodes/audio_tts)
<!-- ROCKETRIDE:GENERATED:PARAMS END -->
