Skip to content

WebSocket.md: Add MEDIA_START notification and remove DRAFT status. #149

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gtjoseph merged 1 commit into from
Jul 16, 2025
Merged

WebSocket.md: Add MEDIA_START notification and remove DRAFT status. #149

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions docs/Configuration/Channel-Drivers/WebSocket.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,4 @@
# WebSocket **DRAFT**

/// warning
This document is in DRAFT status and may change before final publication.
///
# WebSocket

## Background

Expand Down Expand Up @@ -125,6 +121,12 @@ Some of the control TEXT messages you can send the driver have already been ment

/// define

`MEDIA_START`

- The channel driver will send this notification when it connects to the app or the app connects to it.<br>
Example: `MEDIA_START connection_id:e226e283-c90a-4ea9-9e37-389000b9ef47 channel:WebSocket/connectionid format:ulaw optimal_frame_size:160`<br>
Not only does this notification contain the optimal frame size and format, it also contains the channel name and connection id which you can use to correlate incoming connections from the driver to channels you've created.

`MEDIA_XOFF`

- The channel driver will send this notification to the app when the frame queue length reaches the high water (XOFF) level. The app should then pause sending media. Any media sent after this has a high probability of being dropped.
Expand Down