Installation
Install the Stream Kokoro plugin withExample
Check out our Kokoro example to see a practical implementation of the plugin and get inspiration for your own projects, or read on for some key details.Initialisation
The Kokoro plugin for Stream exists in the form of theTTS
class:
To initialise without passing in the API key, make sure the
KOKORO_API_KEY
is available as an environment variable.
You can do this either by defining it in a .env
file or exporting it directly in your terminal.Parameters
These are the parameters available in the KokoroTTS plugin for you to customise:Name | Type | Default | Description |
---|---|---|---|
lang_code | str | "a" | Language code for the TTS model. "a" refers to American English. |
voice | str | "af_heart" | The voice style or speaker preset to use. |
speed | float | 1.0 | Playback speed multiplier. Use values like 0.9 (slower) or 1.2 (faster). |
sample_rate | int | 24000 | Audio sample rate in Hz. |
device | str or None | None | The device to run synthesis on (e.g., "cuda" or "cpu" ). Auto-detected if not specified. |
Functionality
Send text to convert to speech
Thesend()
method sends the text passed in for the service to synthesize.
The resulting audio is then played through the configured output track.