]> git.ipfire.org Git - thirdparty/asterisk.git/commitdiff
chan_websocket_doc.xml: Add d(media_direction) option.
authorBen Ford <bford@sangoma.com>
Fri, 27 Feb 2026 17:25:32 +0000 (11:25 -0600)
committergithub-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Mon, 2 Mar 2026 20:41:41 +0000 (20:41 +0000)
Adds documentation for the 'd' option to set media direction for
chan_websocket.

channels/chan_websocket_doc.xml

index e264783bd3027c65a89d08ec2f042224bfcb4359..63e171a11563a99900d3e373c43a37185083776e 100644 (file)
                                                <para> If not specified, the first codec from the caller's channel will be used.
                                                </para>
                                        </enum>
+                                       <enum name="d(media_direction) - Set the media direction for this call">
+                                               <para>Sets the media direction for the call. It is important to
+                                               note that this is from the perspective of the application, NOT
+                                               Asterisk.</para>
+                                               <enumlist>
+                                               <enum name="both">
+                                               <para>
+                                               The default behavior. Media flows both ways like normal.
+                                               </para>
+                                               </enum>
+                                               <enum name="in">
+                                               <para>
+                                               Asterisk will send media to the application but drop any media
+                                               it receives.
+                                               </para>
+                                               </enum>
+                                               <enum name="out">
+                                               <para>
+                                               Asterisk will only receive media from the application, but will
+                                               not send any media.
+                                               </para>
+                                               </enum>
+                                               </enumlist>
+                                       </enum>
+                                       <enum name="f(format) - Control message format for this call">
+                                               <para>
+                                               format:
+                                               </para>
+                                               <xi:include xpointer="xpointer(/docs/configInfo[@name='chan_websocket']/configFile[@name='chan_websocket.conf']/configObject[@name='global']/configOption[@name='control_message_format']/description/enumlist)"/>
+                                       </enum>
                                        <enum name="n - Don't auto answer">
                                                <para>Normally, the WebSocket channel will be answered when
                                                connection is established with the remote app.  If this
                                                /channels/answer ARI endpoint.
                                                </para>
                                        </enum>
-                                       <enum name="f(format) - Control message format for this call">
-                                               <para>
-                                               format:
-                                               </para>
-                                               <xi:include xpointer="xpointer(/docs/configInfo[@name='chan_websocket']/configFile[@name='chan_websocket.conf']/configObject[@name='global']/configOption[@name='control_message_format']/description/enumlist)"/>
-                                       </enum>
                                        <enum name="p - Passthrough mode">
                                                <para>In passthrough mode, the channel driver won't attempt
                                                to re-frame or re-time media coming in over the websocket from