Skip to content

Commit cb2e3ee

Browse files
committed
TTS streaming README correction
1 parent 4fbffc4 commit cb2e3ee

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

examples/tts/tts_autoplay/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Speechmatics TTS Async Streaming API Client
22

3-
This example shows how to use the Speechmatics TTS API to generate audio from text and autoplay it using sounddevice.
3+
This example shows how to use the Speechmatics TTS API to generate audio from text and autoplay it using sounddevice through the systems default audio output device.
4+
- User must have an audio output device configured on their system for this example to work.
45

56
# audio_generator()
67
This producer function takes a string of text, fetches and decodes audio chunks from the Speechmatics TTS API, and converts the audio data into a queue of samples, ready for the audio player to consume.
@@ -13,6 +14,7 @@ This audio stream is then played in real-time using sounddevice through the syst
1314
# main()
1415
This function orchestrates and creates asyncio tasks for the audio_generator() and audio_player() functions, and then runs them using asyncio.gather(). This allows the audio_generator() and audio_player() functions to run concurrently, and the audio_player() function to autoplay the audio as it is generated.
1516

17+
1618
## Installation
1719

1820
```bash
@@ -27,8 +29,6 @@ To run the example, use the following command:
2729
python tts_stream_example.py
2830
```
2931

30-
This example will generate audio from text and autoplay it using sounddevice. You will need a configured output audio device for it to work.
31-
3232
## Environment Variables
3333

3434
The client supports the following environment variables:

0 commit comments

Comments
 (0)