From 1fcb724c9461f31badb9dd55ec7b68fafe518dca Mon Sep 17 00:00:00 2001 From: streamer45 Date: Fri, 11 Oct 2024 14:02:44 -0600 Subject: [PATCH] Add note --- .../plugins-configuration-settings.rst | 20 ++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/source/configure/plugins-configuration-settings.rst b/source/configure/plugins-configuration-settings.rst index 90dd469cc66..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,9 +957,6 @@ 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 @@ -969,6 +966,9 @@ Enable AV1 (Experimental) - **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`` | @@ -980,9 +980,6 @@ Enable AV1 (Experimental) | :ref:`simulcast is enabled for screen sharing `. | +--------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -Enable DC signaling (Experimental) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - .. config:setting:: plugins-enabledcsignaling :displayname: Use data channels for signaling media tracks (Plugins - Calls) :systemconsole: Plugins > Calls @@ -992,6 +989,9 @@ Enable DC signaling (Experimental) - **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`` | @@ -999,6 +999,8 @@ Enable DC signaling (Experimental) | - **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. | ++----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ ----