You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+13-3Lines changed: 13 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,6 +26,7 @@ Currently, the library supports direct synthesis and the ability to synthesize s
26
26
27
27
-[Installation](#installation)
28
28
-[Get the API Key](#get-the-api-key)
29
+
-[Best Practices for Input Text](#best-practices-for-input-text)
29
30
-[Examples](#examples)
30
31
-[Sync](#sync)
31
32
-[Async](#async)
@@ -49,6 +50,15 @@ When using an SDK in your application, make sure to pin to at least the major ve
49
50
3. Create a new API Key and copy it.
50
51
4. Export the API Key in your environment with the name `SMALLEST_API_KEY`, ensuring that your application can access it securely for authentication.
51
52
53
+
## Best Practices for Input Text
54
+
While the `transliterate` parameter is provided, please note that it is not fully supported and may not perform consistently across all cases. It is recommended to use the model without relying on this parameter.
55
+
56
+
For optimal voice generation results:
57
+
58
+
1. For English, provide the input in Latin script (e.g., "Hello, how are you?").
59
+
2. For Hindi, provide the input in Devanagari script (e.g., "नमस्ते, आप कैसे हैं?").
60
+
3. For code-mixed input, use Latin script for English and Devanagari script for Hindi (e.g., "Hello, आप कैसे हैं?").
The `TextToAudioStream` class provides real-time text-to-speech processing, converting streaming text into audio output with minimal latency. It's particularly useful for applications like voice assistants, live captioning, or interactive chatbots that require immediate audio feedback from text generation. Supports both synchronous and asynchronous TTS instance.
148
+
The `TextToAudioStream` class provides real-time text-to-speech processing, converting streaming text into audio output. It's particularly useful for applications like voice assistants, live captioning, or interactive chatbots that require immediate audio feedback from text generation. Supports both synchronous and asynchronous TTS instance.
139
149
140
150
```python
141
151
import os
@@ -209,7 +219,7 @@ The processor yields raw audio data chunks without WAV headers for streaming eff
0 commit comments