Skip to content

docs: update for pipecat PR #4612 #862

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
markbackman wants to merge 1 commit into
base: main
Choose a base branch
from
+10 −0
Open

docs: update for pipecat PR #4612 #862

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions api-reference/server/services/tts/smallest.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,15 @@ export SMALLEST_API_KEY=your_api_key
sample rate.
</ParamField>

<ParamField path="word_timestamps" type="bool" default="True">
Whether to request per-word timing events. When `True`, the server interleaves
word timestamp messages and the service emits aligned per-word `TTSTextFrame`s
for downstream consumers (captions, lip-sync, RTVI). Supported on base-queue
English and Hindi voices (`meher`, `devansh`, `kartik`, `maithili`, `liam`,
`avery`); other voices silently emit no word events, so leaving this on is safe
regardless of voice. Fixed at init time.
</ParamField>

<ParamField path="settings" type="SmallestTTSService.Settings" default="None">
Runtime-configurable settings. See [Settings](#settings) below.
</ParamField>
Expand Down Expand Up @@ -155,6 +164,7 @@ await task.queue_frame(

- **WebSocket streaming**: The service uses WebSocket connections for real-time streaming. The connection is automatically managed and will reconnect if interrupted.
- **Keepalive**: The service sends periodic keepalive messages (every 30 seconds) to prevent idle timeouts on the WebSocket connection.
- **Word timestamps**: When enabled (the default), word-level timing events are emitted as per-word `TTSTextFrame`s aligned to audio playback. Multiple TTS requests within a turn are automatically offset onto a continuous timeline. Supported on specific voices (`meher`, `devansh`, `kartik`, `maithili`, `liam`, `avery`); other voices produce no word events but function normally.
- **Model-specific parameters**: The `consistency`, `similarity`, and `enhancement` parameters are only effective when using the `lightning-v2` model. They are ignored by `lightning-v3.1`.
- **Language support**: Supports multiple languages including Arabic, Bengali, German, English, Spanish, French, Gujarati, Hebrew, Hindi, Italian, Kannada, Marathi, Dutch, Polish, Russian, and Tamil.

Expand Down
Loading