ben.carrasco/next-static-site
1
0
Fork 0
mirror of https://github.com/jambonz/next-static-site.git synced 2025-12-19 04:47:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

clarify responsiblity for closing the custom speech STT websocket connection (#74)

Browse Source
This commit is contained in:
Dave Horton
2023-07-17 19:16:19 +01:00
committed by GitHub
parent 961df71454
commit bb1a4d0965
1 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
markdown/docs/supporting-articles/custom-speech-stt.md
View File

@@ -7,6 +7,8 @@ The STT API is based on Websockets.
jambonz opens a Websocket connection towards a URL that you specify, and sends audio as well as JSON control text frames to your server. Your server is responsible for implementing the interface to your chosen speech vendor and returning results in JSON format back over the Websocket connection to jambonz.
> **Important Note**: your server is responsible for closing the websocket connection. Generally, this is done after receiving the [stop control message](#h3-stop-control-message) from jambonz.
Want to look at some working code? Check out [these examples](https://github.com/jambonz/custom-speech-example).
## Authentication
@@ -49,6 +51,8 @@ The first message that you will receive from jambonz after accepting and upgradi
jambonz sends a "stop" message when it is time to stop speech recognition.
jambonz does **not** close the socket after sending this control message. This is to allow your speech recognizer to return a final transcript, if necessary. So when receiving the `stop` control message, you should do what is necessary to close and clean up the speech recognition service you are using, return a final transcript if any, and then close the websocket with a normal close.
| property | type | description |
| ---------|-------------| -----|
| type | String | "stop" |