Skip to content
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

Jump to bottom

[MM-45894] Add documentation for Calls EnableDCSignaling setting #7449

Merged
merged 3 commits into from
Oct 14, 2024
Merged

[MM-45894] Add documentation for Calls EnableDCSignaling setting #7449

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a8de25b
Add documentation for Calls EnableDCSignaling setting
streamer45 Oct 7, 2024
b46c581
Merge remote-tracking branch 'origin/master' into MM-45894
streamer45 Oct 11, 2024
1fcb724
Add note
streamer45 Oct 11, 2024
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
38 changes: 30 additions & 8 deletions source/configure/plugins-configuration-settings.rst
View file
Open in desktop
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
Copy link
Member

@cwarnermm cwarnermm Oct 10, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At some point on this page, search meta data started being positioned below the section heading, rather than directly above the section header. As I scroll back, I see a few config settings organized this way. It's my understanding that search meta data needs to be directly above the section heading to return results correctly.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, not sure either, but it should look better now.

: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
Loading