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-13 20:36:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document pipline event run-start: tts_output.stream_response (#2679)

Browse Source
This commit is contained in:
Paulus Schoutsen 2025-05-26 09:54:51 -04:00 committed by GitHub
parent b637084b63
commit a5037b9f32
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -41,7 +41,7 @@ The following events can be emitted:
| Name | Description | Emitted | Attributes |
|----------------|------------------------------|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `run-start` | Start of pipeline run | always | `pipeline` - ID of the pipeline<br />`language` - Language used for pipeline<br />`runner_data` - Extra WebSocket data: <ul><li>`stt_binary_handler_id` is the prefix to send speech data over.</li><li>`timeout` is the max run time for the whole pipeline.</li></ul><br />`tts_output` - TTS Output data<ul><li>`token` - Token of the generated audio</li><li>`url` - URL to the generated audio</li><li>`mime_type` - MIME type of the generated audio</li></ul> |
| `run-start` | Start of pipeline run | always | `pipeline` - ID of the pipeline<br />`language` - Language used for pipeline<br />`runner_data` - Extra WebSocket data: <ul><li>`stt_binary_handler_id` is the prefix to send speech data over.</li><li>`timeout` is the max run time for the whole pipeline.</li></ul><br />`tts_output` - TTS Output data<ul><li>`token` - Token of the generated audio</li><li>`url` - URL to the generated audio</li><li>`mime_type` - MIME type of the generated audio</li><li>`stream_response` - If TTS can stream while the response is being generated.</li></ul> |
| `run-end` | End of pipeline run | always | |
| `wake_word-start` | Start of wake word detection | audio only | `engine`: wake engine used<br />`metadata`: incoming audio<br />`timeout`: seconds before wake word timeout metadata |
| `wake_word-end` | End of wake word detection | audio only | `wake_word_output` - Detection result data: <ul><li>`wake_word_id` is the id of detected wake word</li><li>`timestamp` is the detection time relative to start of audio stream (milliseconds, optional)</li></ul> |