From 27cddb41dff1139f570bbe7d85561a86c9eb616e Mon Sep 17 00:00:00 2001 From: Claudio Costa Date: Mon, 14 Oct 2024 09:17:57 -0600 Subject: [PATCH] [MM-45894] Add documentation for Calls EnableDCSignaling setting (#7449) * Add documentation for Calls EnableDCSignaling setting * Add note --- .../plugins-configuration-settings.rst | 38 +++++++++++++++---- 1 file changed, 30 insertions(+), 8 deletions(-) diff --git a/source/configure/plugins-configuration-settings.rst b/source/configure/plugins-configuration-settings.rst index 6defc68a2f5..70edf2801b7 100644 --- a/source/configure/plugins-configuration-settings.rst +++ b/source/configure/plugins-configuration-settings.rst @@ -938,9 +938,6 @@ Live captions language | - This setting is available starting in plugin version 0.17. | +----------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ -Enable call ringing -~~~~~~~~~~~~~~~~~~~ - .. config:setting:: plugins-enablecallringing :displayname: Enable call ringing (Plugins - Calls) :systemconsole: Plugins > Calls @@ -950,6 +947,9 @@ Enable call ringing - **true**: Ringing functionality is enabled. Direct and group message participants receive a desktop app alert and a ringing notification when a call starts. - **false**: **(False)** Ringing functionality is disabled. +Enable call ringing +~~~~~~~~~~~~~~~~~~~ + +--------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ | - **true**: Ringing functionality is enabled. Direct and group message | - System Config path: **Plugins > Calls** | | participants receive a desktop app alert and a ringing notification | - ``config.json`` setting: ``PluginSettings.Plugins.com.mattermost.calls. enableringing`` | @@ -957,21 +957,21 @@ Enable call ringing | - **false**: **(Default**) Ringing functionality is disabled. | | +--------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -Enable AV1 (Experimental) -~~~~~~~~~~~~~~~~~~~~~~~~~ - .. config:setting:: plugins-enableav1 :displayname: Enable AV1 codec for screen sharing (Plugins - Calls) :systemconsole: Plugins > Calls - :configjson: PluginSettings.Plugins.com.mattermost.calls.enableAV1 + :configjson: PluginSettings.Plugins.com.mattermost.calls.enableav1 :environment: N/A - **true**: Enables the ability to use the AV1 codec to encode screen sharing tracks. This can result in improved screen sharing quality for clients that support it. - **false**: **(False)** AV1 codec is disabled for screen sharing tracks. +Enable AV1 (Experimental) +~~~~~~~~~~~~~~~~~~~~~~~~~ + +--------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ | - **true**: Enables the ability to use the AV1 codec to encode screen | - System Config path: **Plugins > Calls** | -| sharing tracks. Can result in improved screen sharing quality via | - ``config.json`` setting: ``PluginSettings.Plugins.com.mattermost.calls.enableAV1`` | +| sharing tracks. Can result in improved screen sharing quality via | - ``config.json`` setting: ``PluginSettings.Plugins.com.mattermost.calls.enableav1`` | | clients that support AV1 encoding. | - Environment variable: N/A | | - **false**: **(Default**) AV1 codec is disabled for screen sharing | | | tracks. | | @@ -980,6 +980,28 @@ Enable AV1 (Experimental) | :ref:`simulcast is enabled for screen sharing `. | +--------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ +.. config:setting:: plugins-enabledcsignaling + :displayname: Use data channels for signaling media tracks (Plugins - Calls) + :systemconsole: Plugins > Calls + :configjson: PluginSettings.Plugins.com.mattermost.calls.enabledcsignaling + :environment: N/A + + - **true**: Clients will use WebRTC data channels for signaling of media tracks (i.e., voice, screen). This can result in a more efficient and less race-prone process, especially in case of poor network connections. + - **false**: **(False)** Clients will use WebSockets for signaling media tracks. + +Enable DC signaling (Experimental) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + ++----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| - **true**: Clients will use WebRTC data channels for signaling of media | - System Config path: **Plugins > Calls** | +| tracks (i.e., voice, screen). This can result in a more efficient and | - ``config.json`` setting: ``PluginSettings.Plugins.com.mattermost.calls.enabledcsignaling`` | +| less race-prone process, especially in case of poor network connections. | - Environment variable: N/A | +| - **false**: **(Default**) Clients will use WebSockets for signaling | | +| media tracks. | | ++----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| **Note**: Version v0.18.0 or higher of the |rtcd_service| is required for this functionality to work when hosting calls through the dedicated WebRTC service. | ++----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + ---- .. config:setting:: integrations-gitlab