bitmovin-player-ui 4.11.1 → 4.12.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (256) hide show
  1. package/CHANGELOG.md +18 -0
  2. package/dist/js/bitmovinplayer-ui.js +1 -1
  3. package/dist/js/bitmovinplayer-ui.js.map +1 -1
  4. package/dist/js/framework/UIFactory.js +2 -2
  5. package/dist/js/framework/components/lists/AudioTrackListBox.d.ts +5 -2
  6. package/dist/js/framework/components/lists/AudioTrackListBox.js +18 -6
  7. package/dist/js/framework/components/lists/ItemSelectionList.d.ts +1 -2
  8. package/dist/js/framework/components/lists/ItemSelectionList.js +2 -6
  9. package/dist/js/framework/components/lists/ListBox.js +29 -14
  10. package/dist/js/framework/components/lists/ListSelector.d.ts +54 -0
  11. package/dist/js/framework/components/lists/ListSelector.js +123 -27
  12. package/dist/js/framework/components/lists/SubtitleListBox.d.ts +8 -2
  13. package/dist/js/framework/components/lists/SubtitleListBox.js +21 -6
  14. package/dist/js/framework/components/settings/SelectBox.d.ts +1 -2
  15. package/dist/js/framework/components/settings/SelectBox.js +2 -6
  16. package/dist/js/framework/components/settings/SubtitleSelectBox.d.ts +3 -0
  17. package/dist/js/framework/components/settings/SubtitleSelectBox.js +32 -2
  18. package/dist/js/framework/main.d.ts +3 -3
  19. package/dist/js/framework/utils/AudioTrackUtils.d.ts +2 -0
  20. package/dist/js/framework/utils/AudioTrackUtils.js +37 -9
  21. package/dist/js/framework/utils/SubtitleUtils.d.ts +3 -1
  22. package/dist/js/framework/utils/SubtitleUtils.js +27 -8
  23. package/docs/assets/hierarchy.js +1 -1
  24. package/docs/assets/navigation.js +1 -1
  25. package/docs/assets/search.js +1 -1
  26. package/docs/classes/AdClickOverlay.html +28 -28
  27. package/docs/classes/AdControlBar.html +31 -31
  28. package/docs/classes/AdCounterLabel.html +31 -31
  29. package/docs/classes/AdMessageLabel.html +31 -31
  30. package/docs/classes/AdSkipButton.html +27 -27
  31. package/docs/classes/AdStatusOverlay.html +31 -31
  32. package/docs/classes/AirPlayToggleButton.html +35 -35
  33. package/docs/classes/AudioQualitySelectBox.html +48 -40
  34. package/docs/classes/AudioTrackListBox.html +40 -40
  35. package/docs/classes/AudioTrackSelectBox.html +48 -40
  36. package/docs/classes/BackgroundColorSelectBox.html +48 -40
  37. package/docs/classes/BackgroundOpacitySelectBox.html +48 -40
  38. package/docs/classes/BrowserUtils.html +2 -2
  39. package/docs/classes/BufferingOverlay.html +31 -31
  40. package/docs/classes/Button.html +27 -27
  41. package/docs/classes/CastStatusOverlay.html +31 -31
  42. package/docs/classes/CastToggleButton.html +35 -35
  43. package/docs/classes/CastUIContainer.html +31 -31
  44. package/docs/classes/CharacterEdgeColorSelectBox.html +48 -40
  45. package/docs/classes/CharacterEdgeSelectBox.html +48 -40
  46. package/docs/classes/ClickOverlay.html +28 -28
  47. package/docs/classes/CloseButton.html +27 -27
  48. package/docs/classes/Component.html +25 -25
  49. package/docs/classes/Container.html +31 -31
  50. package/docs/classes/ControlBar.html +31 -31
  51. package/docs/classes/DismissClickOverlay.html +31 -31
  52. package/docs/classes/DynamicSettingsPanelItem.html +34 -34
  53. package/docs/classes/EcoModeContainer.html +32 -32
  54. package/docs/classes/EcoModeToggleButton.html +35 -35
  55. package/docs/classes/ErrorMessageOverlay.html +31 -31
  56. package/docs/classes/FontColorSelectBox.html +48 -40
  57. package/docs/classes/FontFamilySelectBox.html +48 -40
  58. package/docs/classes/FontOpacitySelectBox.html +48 -40
  59. package/docs/classes/FontSizeSelectBox.html +48 -40
  60. package/docs/classes/FontStyleSelectBox.html +48 -40
  61. package/docs/classes/FullscreenToggleButton.html +35 -35
  62. package/docs/classes/HugePlaybackToggleButton.html +35 -35
  63. package/docs/classes/HugeReplayButton.html +27 -27
  64. package/docs/classes/I18n.html +2 -2
  65. package/docs/classes/Icon.html +25 -25
  66. package/docs/classes/InteractiveSettingsPanelItem.html +34 -34
  67. package/docs/classes/ItemSelectionList.html +48 -40
  68. package/docs/classes/Label.html +31 -31
  69. package/docs/classes/ListBox.html +39 -39
  70. package/docs/classes/ListSelector.html +48 -40
  71. package/docs/classes/MetadataLabel.html +31 -31
  72. package/docs/classes/NavigationGroup.html +10 -10
  73. package/docs/classes/PictureInPictureToggleButton.html +35 -35
  74. package/docs/classes/PlaybackSpeedSelectBox.html +48 -40
  75. package/docs/classes/PlaybackTimeLabel.html +32 -32
  76. package/docs/classes/PlaybackToggleButton.html +35 -35
  77. package/docs/classes/PlaybackToggleOverlay.html +31 -31
  78. package/docs/classes/PlayerUtils.LiveStreamDetector.html +2 -2
  79. package/docs/classes/PlayerUtils.TimeShiftAvailabilityDetector.html +2 -2
  80. package/docs/classes/PlayerWrapper.html +4 -4
  81. package/docs/classes/QuickSeekButton.html +27 -27
  82. package/docs/classes/RecommendationItem.html +25 -25
  83. package/docs/classes/RecommendationOverlay.html +31 -31
  84. package/docs/classes/ReplayButton.html +27 -27
  85. package/docs/classes/RootNavigationGroup.html +10 -10
  86. package/docs/classes/SeekBar.html +36 -36
  87. package/docs/classes/SeekBarLabel.html +35 -35
  88. package/docs/classes/SelectBox.html +48 -40
  89. package/docs/classes/SettingsPanel.html +39 -39
  90. package/docs/classes/SettingsPanelItem.html +33 -33
  91. package/docs/classes/SettingsPanelNavigationGroup.html +10 -10
  92. package/docs/classes/SettingsPanelNavigationGroupConfig.html +2 -2
  93. package/docs/classes/SettingsPanelPage.html +33 -33
  94. package/docs/classes/SettingsPanelPageBackButton.html +29 -29
  95. package/docs/classes/SettingsPanelPageNavigatorButton.html +29 -29
  96. package/docs/classes/SettingsPanelPageOpenButton.html +29 -29
  97. package/docs/classes/SettingsPanelSelectOption.html +34 -34
  98. package/docs/classes/SettingsToggleButton.html +35 -35
  99. package/docs/classes/ShadowDomManager.html +2 -2
  100. package/docs/classes/SmallCenteredPlaybackToggleButton.html +35 -35
  101. package/docs/classes/Spacer.html +25 -25
  102. package/docs/classes/SpatialNavigation.html +4 -4
  103. package/docs/classes/SubtitleListBox.html +42 -40
  104. package/docs/classes/SubtitleOverlay.html +31 -31
  105. package/docs/classes/SubtitleSelectBox.html +50 -40
  106. package/docs/classes/SubtitleSettingSelectBox.html +48 -40
  107. package/docs/classes/SubtitleSettingsPanelPage.html +33 -33
  108. package/docs/classes/SubtitleSettingsResetButton.html +27 -27
  109. package/docs/classes/TitleBar.html +31 -31
  110. package/docs/classes/ToggleButton.html +35 -35
  111. package/docs/classes/TouchControlOverlay.html +31 -31
  112. package/docs/classes/TvNoiseCanvas.html +25 -25
  113. package/docs/classes/UIContainer.html +31 -31
  114. package/docs/classes/UIInstanceManager.html +14 -14
  115. package/docs/classes/UIManager.html +15 -15
  116. package/docs/classes/VRToggleButton.html +35 -35
  117. package/docs/classes/VideoQualitySelectBox.html +49 -41
  118. package/docs/classes/VolumeControlButton.html +33 -33
  119. package/docs/classes/VolumeSlider.html +36 -36
  120. package/docs/classes/VolumeToggleButton.html +35 -35
  121. package/docs/classes/Watermark.html +28 -28
  122. package/docs/classes/WindowColorSelectBox.html +48 -40
  123. package/docs/classes/WindowOpacitySelectBox.html +48 -40
  124. package/docs/enums/ButtonStyle.html +5 -5
  125. package/docs/enums/LabelStyle.html +4 -4
  126. package/docs/enums/MetadataLabelContent.html +3 -3
  127. package/docs/enums/NavigationDirection.html +2 -2
  128. package/docs/enums/PlaybackTimeLabelMode.html +5 -5
  129. package/docs/enums/PlayerUtils.PlayerState.html +2 -2
  130. package/docs/enums/UIUtils.KeyCode.html +2 -2
  131. package/docs/enums/ViewMode.html +3 -3
  132. package/docs/functions/ArrayUtils.remove.html +1 -1
  133. package/docs/functions/ErrorUtils.defaultMobileV3ErrorMessageTranslator.html +1 -1
  134. package/docs/functions/PlayerUtils.clampValueToRange.html +1 -1
  135. package/docs/functions/PlayerUtils.getCurrentTimeRelativeToSeekableRange.html +1 -1
  136. package/docs/functions/PlayerUtils.getSeekableRangeRespectingLive.html +1 -1
  137. package/docs/functions/PlayerUtils.getSeekableRangeStart.html +1 -1
  138. package/docs/functions/PlayerUtils.getState.html +1 -1
  139. package/docs/functions/PlayerUtils.isTimeShiftAvailable.html +1 -1
  140. package/docs/functions/StorageUtils.getItem.html +1 -1
  141. package/docs/functions/StorageUtils.getObject.html +1 -1
  142. package/docs/functions/StorageUtils.setItem.html +1 -1
  143. package/docs/functions/StorageUtils.setObject.html +1 -1
  144. package/docs/functions/StorageUtils.setStorageApiDisabled.html +1 -1
  145. package/docs/functions/StringUtils.replaceAdMessagePlaceholders.html +1 -1
  146. package/docs/functions/StringUtils.secondsToText.html +1 -1
  147. package/docs/functions/StringUtils.secondsToTime.html +1 -1
  148. package/docs/functions/UIFactory.buildCastReceiverUI.html +1 -1
  149. package/docs/functions/UIFactory.buildSmallScreenUI.html +1 -1
  150. package/docs/functions/UIFactory.buildSubtitleUI.html +1 -1
  151. package/docs/functions/UIFactory.buildTvUI.html +1 -1
  152. package/docs/functions/UIFactory.buildUI.html +1 -1
  153. package/docs/functions/UIFactory.defaultLayouts.ads.html +1 -1
  154. package/docs/functions/UIFactory.defaultLayouts.castReceiver.html +1 -1
  155. package/docs/functions/UIFactory.defaultLayouts.emptyState.html +1 -1
  156. package/docs/functions/UIFactory.defaultLayouts.main.html +1 -1
  157. package/docs/functions/UIFactory.defaultLayouts.smallScreen.html +1 -1
  158. package/docs/functions/UIFactory.defaultLayouts.smallScreenAds.html +1 -1
  159. package/docs/functions/UIFactory.defaultLayouts.subtitle.html +1 -1
  160. package/docs/functions/UIFactory.defaultLayouts.tv.html +1 -1
  161. package/docs/functions/UIFactory.defaultLayouts.tvAds.html +1 -1
  162. package/docs/functions/UIUtils.traverseTree.html +1 -1
  163. package/docs/hierarchy.html +1 -1
  164. package/docs/interfaces/ActiveUiChangedArgs.html +3 -3
  165. package/docs/interfaces/AdControlBarConfig.html +12 -12
  166. package/docs/interfaces/AdSkipButtonConfig.html +16 -16
  167. package/docs/interfaces/AudioTrackListBoxConfig.html +49 -0
  168. package/docs/interfaces/BufferingOverlayConfig.html +13 -13
  169. package/docs/interfaces/ButtonConfig.html +14 -14
  170. package/docs/interfaces/ClickOverlayConfig.html +15 -15
  171. package/docs/interfaces/CloseButtonConfig.html +15 -15
  172. package/docs/interfaces/ComponentConfig.html +11 -11
  173. package/docs/interfaces/ComponentFocusChangedEventArgs.html +2 -2
  174. package/docs/interfaces/ComponentHoverChangedEventArgs.html +2 -2
  175. package/docs/interfaces/ContainerConfig.html +12 -12
  176. package/docs/interfaces/ControlBarConfig.html +12 -12
  177. package/docs/interfaces/DismissClickOverlayConfig.html +14 -14
  178. package/docs/interfaces/DynamicSettingsPanelItemConfig.html +19 -19
  179. package/docs/interfaces/ErrorMessageMap.html +1 -1
  180. package/docs/interfaces/ErrorMessageOverlayConfig.html +13 -13
  181. package/docs/interfaces/ErrorMessageTranslator.html +1 -1
  182. package/docs/interfaces/ExternalRecommendationLink.html +3 -3
  183. package/docs/interfaces/InternalUIConfig.html +18 -18
  184. package/docs/interfaces/LabelConfig.html +14 -14
  185. package/docs/interfaces/ListBoxConfig.html +22 -17
  186. package/docs/interfaces/ListItem.html +2 -2
  187. package/docs/interfaces/ListItemFilter.html +1 -1
  188. package/docs/interfaces/ListItemLabelTranslator.html +1 -1
  189. package/docs/interfaces/ListSelectorConfig.html +16 -11
  190. package/docs/interfaces/LocalizationConfig.html +5 -5
  191. package/docs/interfaces/MetadataLabelConfig.html +15 -15
  192. package/docs/interfaces/PlaybackTimeLabelConfig.html +16 -16
  193. package/docs/interfaces/PlaybackToggleButtonConfig.html +19 -19
  194. package/docs/interfaces/PlaybackToggleOverlayConfig.html +13 -13
  195. package/docs/interfaces/PlayerUtils.LiveStreamDetectorEventArgs.html +2 -2
  196. package/docs/interfaces/PlayerUtils.TimeShiftAvailabilityChangedArgs.html +2 -2
  197. package/docs/interfaces/QuickSeekButtonConfig.html +15 -15
  198. package/docs/interfaces/RecommendationConfig.html +4 -4
  199. package/docs/interfaces/RecommendationItemConfig.html +12 -12
  200. package/docs/interfaces/SeekBarConfig.html +19 -19
  201. package/docs/interfaces/SeekBarLabelConfig.html +12 -12
  202. package/docs/interfaces/SeekBarMarker.html +2 -2
  203. package/docs/interfaces/SeekPreviewArgs.html +3 -3
  204. package/docs/interfaces/SeekPreviewEventArgs.html +4 -4
  205. package/docs/interfaces/SettingsPanelConfig.html +15 -15
  206. package/docs/interfaces/SettingsPanelItemConfig.html +17 -17
  207. package/docs/interfaces/SettingsPanelPageConfig.html +13 -13
  208. package/docs/interfaces/SettingsPanelPageNavigatorConfig.html +17 -17
  209. package/docs/interfaces/SettingsPanelSelectOptionConfig.html +18 -18
  210. package/docs/interfaces/SettingsPanelState.html +2 -2
  211. package/docs/interfaces/SettingsToggleButtonConfig.html +20 -20
  212. package/docs/interfaces/ShadowDomConfig.html +4 -4
  213. package/docs/interfaces/SubtitleListBoxConfig.html +49 -0
  214. package/docs/interfaces/SubtitleSettingSelectBoxConfig.html +16 -11
  215. package/docs/interfaces/SubtitleSettingsPanelPageConfig.html +13 -13
  216. package/docs/interfaces/TimelineMarker.html +6 -6
  217. package/docs/interfaces/TitleBarConfig.html +13 -13
  218. package/docs/interfaces/ToggleButtonConfig.html +18 -18
  219. package/docs/interfaces/TouchControlOverlayConfig.html +17 -17
  220. package/docs/interfaces/UIConditionContext.html +10 -10
  221. package/docs/interfaces/UIConditionResolver.html +1 -1
  222. package/docs/interfaces/UIConfig.html +16 -16
  223. package/docs/interfaces/UIContainerConfig.html +17 -17
  224. package/docs/interfaces/UIUtils.TreeTraversalCallback.html +1 -1
  225. package/docs/interfaces/UIVariant.html +2 -2
  226. package/docs/interfaces/ViewModeChangedEventArgs.html +2 -2
  227. package/docs/interfaces/Vocabularies.html +1 -1
  228. package/docs/interfaces/Vocabulary.html +2 -2
  229. package/docs/interfaces/VolumeControlButtonConfig.html +14 -14
  230. package/docs/interfaces/VolumeSliderConfig.html +21 -21
  231. package/docs/interfaces/WatermarkConfig.html +15 -15
  232. package/docs/interfaces/WrappedPlayer.html +2 -2
  233. package/docs/media/CHANGELOG.md +18 -0
  234. package/docs/modules.html +1 -1
  235. package/docs/types/CustomVocabulary.html +1 -1
  236. package/docs/types/ListItemComparator.html +6 -0
  237. package/docs/types/LocalizableText.html +1 -1
  238. package/docs/types/Localizer.html +1 -1
  239. package/docs/variables/ErrorUtils.defaultErrorMessages.html +1 -1
  240. package/docs/variables/ErrorUtils.defaultWebErrorMessageTranslator.html +1 -1
  241. package/docs/variables/StringUtils.FORMAT_HHMMSS.html +1 -1
  242. package/docs/variables/StringUtils.FORMAT_MMSS.html +1 -1
  243. package/docs/variables/i18n.html +1 -1
  244. package/docs/variables/version.html +1 -1
  245. package/package.json +1 -1
  246. package/src/ts/UIFactory.ts +2 -2
  247. package/src/ts/components/lists/AudioTrackListBox.ts +13 -4
  248. package/src/ts/components/lists/ItemSelectionList.ts +2 -7
  249. package/src/ts/components/lists/ListBox.ts +34 -15
  250. package/src/ts/components/lists/ListSelector.ts +158 -28
  251. package/src/ts/components/lists/SubtitleListBox.ts +16 -4
  252. package/src/ts/components/settings/SelectBox.ts +2 -7
  253. package/src/ts/components/settings/SubtitleSelectBox.ts +30 -3
  254. package/src/ts/main.ts +3 -2
  255. package/src/ts/utils/AudioTrackUtils.ts +34 -9
  256. package/src/ts/utils/SubtitleUtils.ts +35 -10
package/CHANGELOG.md CHANGED
@@ -5,6 +5,24 @@ All notable changes to this project will be documented in this file.
5
5
  The format is based on [Keep a Changelog](http://keepachangelog.com/)
6
6
  and this project adheres to [Semantic Versioning](http://semver.org/).
7
7
 
8
+ ## [4.12.0] - 2026-04-30
9
+
10
+ ### Added
11
+
12
+ - `ListSelectorConfig.comparator` to customize the display order of list-backed selection UIs such as `AudioTrackSelectBox`, `SubtitleSelectBox`, `AudioTrackListBox`, and `SubtitleListBox`. For subtitle selection UIs, the built-in `Off` option remains fixed at the top.
13
+ Example:
14
+ ```ts
15
+ const subtitleListBox = new SubtitleListBox({
16
+ title: i18n.getLocalizer('settings.subtitles'),
17
+ comparator: (a, b) => String(a.label).localeCompare(String(b.label)), // A-Z
18
+ });
19
+ ```
20
+ > **Note**: Requires building a custom UI. The default `UIFactory` presets do not expose this option.
21
+ - `AudioTrackListBox` and `SubtitleListBox` now can accept config objects that extend `ListBoxConfig` without `listSelector`.
22
+ This enables configuring list-selector behavior such as `comparator`, `filter`, and `translator`, as well as list-box/settings-panel options like `title`, `hideDelay`, and related panel settings.
23
+ - `ListSelector.onItemsChanged` event that fires whenever the effective item collection changes, including item additions, removals, reordering, or updates to rendered item data such as `label` and `ariaLabel`.
24
+ This event should be used by consumers that rebuild the full list UI from `getItems()`, while `onItemAdded` and `onItemRemoved` remain strict membership-change events.
25
+
8
26
  ## [4.11.1] - 2026-04-23
9
27
 
10
28
  ### Fixed