Skip to main content

Kokoro TTS plugin for GetStream

Project description

GetStream Kokoro Plugin

This package integrates the open-weight Kokoro-82M TTS model with the GetStream audio/video SDK.

It provides a drop-in KokoroTTS class that implements the common getstream_common.tts.TTS interface, allowing you to stream PCM audio generated by Kokoro directly into a WebRTC AudioStreamTrack.

from getstream.plugins.kokoro import KokoroTTS
from getstream.video.rtc.audio_track import AudioStreamTrack

track = AudioStreamTrack(framerate=24_000)

tts = KokoroTTS(lang_code="a", voice="af_heart")
tts.set_output_track(track)

await tts.send("Hello from Kokoro!")

Installation

pip install getstream-plugins-kokoro

This will pull in the required kokoro, numpy and getstream[webrtc] dependencies. You also need espeak-ng at runtime for pronunciation fallback. On macOS you can install it with Homebrew:

brew install espeak-ng

Configuration options

Parameter Default Description
lang_code "a" Language group passed to KPipeline ("a" = American English, etc.)
voice "af_heart" Kokoro voice preset. See the model card for available options.
speed 1.0 Playback speed multiplier.
sample_rate 24000 Output sample-rate (fixed by Kokoro). The attached AudioStreamTrack must use the same value.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

getstream_plugins_kokoro-0.1.0-py3-none-any.whl (5.5 kB view details)

Uploaded Python 3

File details

Details for the file getstream_plugins_kokoro-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for getstream_plugins_kokoro-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ba10146c65dbd3c7e36d44674c7f738ac4672584b70ce76c433b05ae49a7e40d
MD5 7d848193823dfbe17cc09ca4075d8c5c
BLAKE2b-256 ec31d21ee963317d167e6b9f71c3b200858f2c8e927299dd6ec5f81b04e3d0b8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page