From 2e97c55005d09e1fea6636bc071919d481988fca Mon Sep 17 00:00:00 2001 From: Cameron Gutman Date: Mon, 26 Feb 2024 22:00:46 -0600 Subject: [PATCH] Move and rename Channels option to feature more prominently in the UI --- docs/source/about/advanced_usage.rst | 41 +++++++++++------------- src_assets/common/assets/web/config.html | 25 ++++++--------- 2 files changed, 28 insertions(+), 38 deletions(-) diff --git a/docs/source/about/advanced_usage.rst b/docs/source/about/advanced_usage.rst index 6d87eb0c..f376f658 100644 --- a/docs/source/about/advanced_usage.rst +++ b/docs/source/about/advanced_usage.rst @@ -92,6 +92,24 @@ editing the `conf` file in a text editor. Use the examples as reference. min_log_level = info +`channels `__ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +**Description** + Sunshine can support multiple clients streaming simultaneously, at the cost of higher CPU and GPU usage. + + .. note:: All connected clients share control of the same streaming session. + + .. warning:: Some hardware encoders may have limitations that reduce performance with multiple streams. + +**Default** + ``1`` + +**Example** + .. code-block:: text + + channels = 1 + `global_prep_cmd `__ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -913,29 +931,6 @@ keybindings `Advanced `__ ------------------------------------------------------- -`channels `__ -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -**Description** - This will generate distinct video streams, unlike simply broadcasting to multiple Clients. - - When multicasting, it could be useful to have different configurations for each connected Client. - - For instance: - - - Clients connected through WAN and LAN have different bitrate constraints. - - Decoders may require different settings for color. - - .. warning:: CPU usage increases for each distinct video stream generated. - -**Default** - ``1`` - -**Example** - .. code-block:: text - - channels = 1 - `fec_percentage `__ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/src_assets/common/assets/web/config.html b/src_assets/common/assets/web/config.html index 17aea3d1..3921f966 100644 --- a/src_assets/common/assets/web/config.html +++ b/src_assets/common/assets/web/config.html @@ -64,6 +64,16 @@ + +
+ + +
+ Sunshine can allow a single streaming session to be shared with multiple clients simultaneously.
+ Note: Some hardware encoders may have limitations that reduce performance with multiple streams. +
+
+
@@ -721,21 +731,6 @@
- -
- - -
- When multicasting, it could be useful to have different configurations for each connected Client. For example: -
    -
  • Clients connected through WAN and LAN have different bitrate constraints.
  • -
  • Decoders may require different settings for color
  • -
- Unlike simply broadcasting to multiple Client, this will generate distinct video streams.
- Note, CPU usage increases for each distinct video stream generated -
-
-