From 138f867fa4c0c8aa6c7c1c121ff863aecf1530dd Mon Sep 17 00:00:00 2001 From: Lukas Kalbertodt Date: Fri, 12 Jul 2024 13:25:37 +0200 Subject: [PATCH] Add docs about `showForSingleQuality` for quality selector plugin --- doc/tutorial/quality_selector.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/doc/tutorial/quality_selector.md b/doc/tutorial/quality_selector.md index 6bce27d4..03191b5c 100644 --- a/doc/tutorial/quality_selector.md +++ b/doc/tutorial/quality_selector.md @@ -14,6 +14,7 @@ The necessary plugin is already installed, because it belongs to the `paella-bas "side": "right", "order": "2", "showIcon": false, + "showForSingleQuality": false, "menuTitle": "Video Quality", "parentContainer": "options" } @@ -25,6 +26,8 @@ We already know most of the configuration options we have added: `side`, `order` The `showIcon` option is specific to this plugin, and indicates whether we want to show an icon on the button that displays the video quality options. If `true`, then a white box icon containing the text of the selected resolution is displayed. If the video quality labels are somewhat long, it is preferable to leave the option to `false`, which will make the width of the button fit the size of the text it contains. +If the `showForSingleQuality` option is set to `true`, then the quality selector is also shown if there is only a single quality available. This can be useful so that the user can at least the current quality (even if they cannot change it). Further, when the quality selector is in a sub-menu, it can be useful to always have that button to avoid ending up with a completely empty sub-menu. + To test the new icon, you can use the HLS stream example we added in the [previous tutorial](video_formats.md): `http://localhost:5173/?id=hls-dual`