Skip to content

Commit aa8c272

Browse files
J-JaywalkerJames WalkerLArmstrongDevyaiir-a
authored
Add EndOfChannel guidance into the rt dz docs (#141)
Currently, we have no mention of when to use EndOfChannel in the RT DZ docs, despite adding it to the RT API ref. This change adds a Closing Channels section describing what to do when ending a channel or session. Also see: https://gitlab1.speechmatics.io/aml/aladdin/-/merge_requests/11329 --------- Co-authored-by: James Walker <[email protected]> Co-authored-by: Lorna Armstrong <[email protected]> Co-authored-by: Yahia <[email protected]>
1 parent cb1ca60 commit aa8c272

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

docs/speech-to-text/realtime/realtime_diarization.mdx

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -215,6 +215,27 @@ Transcripts are returned in the same way as channel diarization, but with indivi
215215

216216
When using `channel_and_speaker` diarization, speaker labelling is specific to channels even if the speaker labels are the same. S1 on channel 1 is not necessarily the same as S1 on channel 2.
217217

218+
## Closing Channels
219+
220+
When you're finished with a channel, you can signal that it's no longer in use by sending an [EndOfChannel](../../api-ref/realtime-transcription-websocket#endofchannel) message.
221+
```json
222+
{
223+
// highlight-start
224+
"message": "EndOfChannel",
225+
"channel": "New_York",
226+
"last_seq_no": 2564
227+
// highlight-end
228+
}
229+
```
230+
231+
Once this happens, the channel will stop accepting or processing any additional data. When all channels are closed, the session ends. This may be more convenient to use when you don't want to keep track of the number of open channels in a given stream.
232+
233+
You can also use [EndOfStream](../../api-ref/realtime-transcription-websocket#endofstream) to simultaneously close all channels. This may be more convenient to use when you know you want to close all channels at the same time.
234+
235+
:::info
236+
At this time, closing an individual channel has no impact on pricing.
237+
:::
238+
218239
### Limits
219240

220241
For SaaS customers, the maximum number of channels is 2.

0 commit comments

Comments
 (0)