jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-11 03:16:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document sending Assist pipeline speech data (#1803)

Browse Source
This commit is contained in:
Joris Pelgröm 2023-07-13 00:24:11 +02:00 committed by GitHub
parent 7b024e52d7
commit c78d18eed1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/voice/pipelines/index.md
View File

@ -49,3 +49,14 @@ The following events can be emitted:
| `tts-end` | End of text to speech | audio only | `media_id` - Media Source ID of the generated audio<br />`url` - URL to the generated audio<br />`mime_type` - MIME type of the generated audio<br /> | | `tts-end` | End of text to speech | audio only | `media_id` - Media Source ID of the generated audio<br />`url` - URL to the generated audio<br />`mime_type` - MIME type of the generated audio<br /> |
| `error` | Error in pipeline | On error | `code` - Error code<br />`message` - Error message | | `error` | Error in pipeline | On error | `code` - Error code<br />`message` - Error message |
## Sending speech data
After starting a pipeline with `stt` as the first stage of the run and receiving a `stt-start` event, speech data can be sent over the WebSocket connection as binary data. Audio should be sent as soon as it is available, with each chunk prefixed with a byte for the `stt_binary_handler_id`.
For example, if `stt_binary_handler_id` is `1` and the audio chunk is `a1b2c3`, the message would be (in hex):
```
01a1b2c3
```
To indicate the end of sending speech data, send a binary message containing a single byte with the `stt_binary_handler_id`.