feat(UI): Separate trackLabelFormat settings for text tracks and audi…

…o tracks (#6052) Closes #6008
shaka-project · Jan 9, 2024 · a94a602 · a94a602
1 parent c189922
commit a94a602
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 3 deletions.
diff --git a/ui/externs/ui.js b/ui/externs/ui.js
@@ -87,6 +87,7 @@ shaka.extern.UIVolumeBarColors;
  *   seekBarColors: shaka.extern.UISeekBarColors,
  *   volumeBarColors: shaka.extern.UIVolumeBarColors,
  *   trackLabelFormat: shaka.ui.Overlay.TrackLabelFormat,
+ *   textTrackLabelFormat: shaka.ui.Overlay.TrackLabelFormat,
  *   fadeDelay: number,
  *   doubleClickForFullscreen: boolean,
  *   singleClickForPlayAndPause: boolean,
@@ -156,8 +157,18 @@ shaka.extern.UIVolumeBarColors;
  *   colors used in the linear gradient constructed in JavaScript, since you
  *   cannot do this in pure CSS.
  * @property {shaka.ui.Overlay.TrackLabelFormat} trackLabelFormat
- *   An enum that determines what is shown in the labels for text track and
- *   audio variant selection.
+ *   An enum that determines what is shown in the labels for audio variant
+ *   selection.
+ *   LANGUAGE means that only the language of the item is shown.
+ *   ROLE means that only the role of the item is shown.
+ *   LANGUAGE_ROLE means both language and role are shown, or just language if
+ *   there is no role.
+ *   LABEL means the non-standard DASH "label" attribute or the standard DASH
+ *   "Label" element or the HLS "NAME" attribute are shown.
+ *   Defaults to LANGUAGE.
+ * @property {shaka.ui.Overlay.TrackLabelFormat} textTrackLabelFormat
+ *   An enum that determines what is shown in the labels for text track
+ *   selection.
  *   LANGUAGE means that only the language of the item is shown.
  *   ROLE means that only the role of the item is shown.
  *   LANGUAGE_ROLE means both language and role are shown, or just language if

diff --git a/ui/text_selection.js b/ui/text_selection.js
@@ -135,7 +135,7 @@ shaka.ui.TextSelection = class extends shaka.ui.SettingsMenu {
         this.player.isTextTrackVisible(),
         this.currentSelection,
         this.localization,
-        this.controls.getConfig().trackLabelFormat,
+        this.controls.getConfig().textTrackLabelFormat,
         this.controls.getConfig().showAudioChannelCountVariants);
 
     // Add the Off button

diff --git a/ui/ui.js b/ui/ui.js
@@ -237,6 +237,7 @@ shaka.ui.Overlay = class {
         level: 'rgb(255, 255, 255)',
       },
       trackLabelFormat: shaka.ui.Overlay.TrackLabelFormat.LANGUAGE,
+      textTrackLabelFormat: shaka.ui.Overlay.TrackLabelFormat.LANGUAGE,
       fadeDelay: 0,
       doubleClickForFullscreen: true,
       singleClickForPlayAndPause: true,