Skip to content

Commit

Permalink
Merge branch 'master' into v10.1-documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@amyblais
amyblais authored Oct 15, 2024
2 parents bb6d45b + 27cddb4 commit 5b7a86a
Showing 1 changed file with 30 additions and 8 deletions.
38 changes: 30 additions & 8 deletions source/configure/plugins-configuration-settings.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -950,28 +947,31 @@ 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`` |
| when a call starts. | - Environment variable: N/A |
| - **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. | |
Expand All @@ -980,6 +980,28 @@ Enable AV1 (Experimental)
| :ref:`simulcast is enabled for screen sharing <configure/plugins-configuration-settings:enable simulcast for screen sharing (experimental)>`. |
+--------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+

.. 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
Expand Down

0 comments on commit 5b7a86a

Please sign in to comment.