bitmovin-player-ui 4.21.1 → 4.22.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 (291) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/dist/css/bitmovinplayer-ui.css +1 -1
  3. package/dist/css/bitmovinplayer-ui.css.map +1 -1
  4. package/dist/js/bitmovinplayer-ui.js +1 -1
  5. package/dist/js/bitmovinplayer-ui.js.map +1 -1
  6. package/dist/js/framework/UIComponentConfigOverrides.d.ts +4 -0
  7. package/dist/js/framework/UIComponentLayoutOverrides.d.ts +4 -0
  8. package/dist/js/framework/UIFactory.js +16 -2
  9. package/dist/js/framework/UIManager.d.ts +1 -0
  10. package/dist/js/framework/UIManager.js +27 -0
  11. package/dist/js/framework/components/ads/PauseAdStatusOverlay.d.ts +33 -0
  12. package/dist/js/framework/components/ads/PauseAdStatusOverlay.js +172 -0
  13. package/dist/js/framework/components/overlays/TouchControlOverlay.d.ts +12 -0
  14. package/dist/js/framework/components/overlays/TouchControlOverlay.js +27 -2
  15. package/dist/js/framework/main.d.ts +1 -0
  16. package/dist/js/framework/main.js +4 -2
  17. package/dist/js/framework/spatialnavigation/NavigationGroup.d.ts +2 -1
  18. package/dist/js/framework/spatialnavigation/NavigationGroup.js +11 -2
  19. package/dist/js/framework/spatialnavigation/PauseAdNavigationGroup.d.ts +20 -0
  20. package/dist/js/framework/spatialnavigation/PauseAdNavigationGroup.js +75 -0
  21. package/dist/js/framework/spatialnavigation/SeekBarHandler.d.ts +2 -2
  22. package/dist/js/framework/utils/NonLinearAdEvents.d.ts +3 -0
  23. package/dist/js/framework/utils/NonLinearAdEvents.js +17 -0
  24. package/docs/assets/hierarchy.js +1 -1
  25. package/docs/assets/navigation.js +1 -1
  26. package/docs/assets/search.js +1 -1
  27. package/docs/classes/AdClickOverlay.html +28 -28
  28. package/docs/classes/AdControlBar.html +31 -31
  29. package/docs/classes/AdCounterLabel.html +31 -31
  30. package/docs/classes/AdMessageLabel.html +31 -31
  31. package/docs/classes/AdSkipButton.html +27 -27
  32. package/docs/classes/AdStatusOverlay.html +31 -31
  33. package/docs/classes/AirPlayToggleButton.html +35 -35
  34. package/docs/classes/AudioQualitySelectBox.html +41 -41
  35. package/docs/classes/AudioTrackListBox.html +39 -39
  36. package/docs/classes/AudioTrackSelectBox.html +41 -41
  37. package/docs/classes/BackgroundColorSelectBox.html +41 -41
  38. package/docs/classes/BackgroundOpacitySelectBox.html +41 -41
  39. package/docs/classes/BrowserUtils.html +2 -2
  40. package/docs/classes/BufferingOverlay.html +31 -31
  41. package/docs/classes/Button.html +27 -27
  42. package/docs/classes/CaptionToggleButton.html +35 -35
  43. package/docs/classes/CastStatusOverlay.html +31 -31
  44. package/docs/classes/CastToggleButton.html +35 -35
  45. package/docs/classes/CastUIContainer.html +31 -31
  46. package/docs/classes/CharacterEdgeColorSelectBox.html +41 -41
  47. package/docs/classes/CharacterEdgeSelectBox.html +41 -41
  48. package/docs/classes/ClickOverlay.html +28 -28
  49. package/docs/classes/CloseButton.html +27 -27
  50. package/docs/classes/Component.html +25 -25
  51. package/docs/classes/Container.html +31 -31
  52. package/docs/classes/ContextMenu.html +39 -39
  53. package/docs/classes/ControlBar.html +31 -31
  54. package/docs/classes/DismissClickOverlay.html +31 -31
  55. package/docs/classes/DynamicSettingsPanelItem.html +34 -34
  56. package/docs/classes/EcoModeContainer.html +32 -32
  57. package/docs/classes/EcoModeToggleButton.html +35 -35
  58. package/docs/classes/ErrorMessageOverlay.html +31 -31
  59. package/docs/classes/FontColorSelectBox.html +41 -41
  60. package/docs/classes/FontFamilySelectBox.html +41 -41
  61. package/docs/classes/FontOpacitySelectBox.html +41 -41
  62. package/docs/classes/FontSizeSelectBox.html +41 -41
  63. package/docs/classes/FontStyleSelectBox.html +41 -41
  64. package/docs/classes/FullscreenToggleButton.html +35 -35
  65. package/docs/classes/HugePlaybackToggleButton.html +35 -35
  66. package/docs/classes/HugeReplayButton.html +27 -27
  67. package/docs/classes/I18n.html +2 -2
  68. package/docs/classes/Icon.html +25 -25
  69. package/docs/classes/InteractiveContextMenuItem.html +34 -34
  70. package/docs/classes/InteractiveSettingsPanelItem.html +34 -34
  71. package/docs/classes/ItemSelectionList.html +41 -41
  72. package/docs/classes/Label.html +31 -31
  73. package/docs/classes/ListBox.html +39 -39
  74. package/docs/classes/ListSelector.html +41 -41
  75. package/docs/classes/MetadataLabel.html +31 -31
  76. package/docs/classes/NavigationGroup.html +12 -12
  77. package/docs/classes/PauseAdStatusOverlay.html +107 -0
  78. package/docs/classes/PersistentPreferencesToggleButton.html +35 -35
  79. package/docs/classes/PictureInPictureToggleButton.html +35 -35
  80. package/docs/classes/PlaybackSpeedSelectBox.html +41 -41
  81. package/docs/classes/PlaybackTimeLabel.html +32 -32
  82. package/docs/classes/PlaybackToggleButton.html +35 -35
  83. package/docs/classes/PlaybackToggleOverlay.html +31 -31
  84. package/docs/classes/PlayerContextMenu.html +39 -39
  85. package/docs/classes/PlayerInsightsPanel.html +39 -39
  86. package/docs/classes/PlayerUtils.LiveStreamDetector.html +2 -2
  87. package/docs/classes/PlayerUtils.TimeShiftAvailabilityDetector.html +2 -2
  88. package/docs/classes/PlayerWrapper.html +4 -4
  89. package/docs/classes/QuickSeekButton.html +27 -27
  90. package/docs/classes/RecommendationItem.html +25 -25
  91. package/docs/classes/RecommendationOverlay.html +31 -31
  92. package/docs/classes/ReplayButton.html +27 -27
  93. package/docs/classes/RootNavigationGroup.html +12 -12
  94. package/docs/classes/SeekBar.html +36 -36
  95. package/docs/classes/SeekBarLabel.html +35 -35
  96. package/docs/classes/SelectBox.html +41 -41
  97. package/docs/classes/SettingsPanel.html +39 -39
  98. package/docs/classes/SettingsPanelItem.html +33 -33
  99. package/docs/classes/SettingsPanelNavigationGroup.html +12 -12
  100. package/docs/classes/SettingsPanelNavigationGroupConfig.html +2 -2
  101. package/docs/classes/SettingsPanelPage.html +33 -33
  102. package/docs/classes/SettingsPanelPageBackButton.html +29 -29
  103. package/docs/classes/SettingsPanelPageNavigatorButton.html +29 -29
  104. package/docs/classes/SettingsPanelPageOpenButton.html +29 -29
  105. package/docs/classes/SettingsPanelSelectOption.html +34 -34
  106. package/docs/classes/SettingsPanelSeparator.html +31 -31
  107. package/docs/classes/SettingsToggleButton.html +35 -35
  108. package/docs/classes/ShadowDomManager.html +2 -2
  109. package/docs/classes/SmallCenteredPlaybackToggleButton.html +35 -35
  110. package/docs/classes/Spacer.html +25 -25
  111. package/docs/classes/SpatialNavigation.html +4 -4
  112. package/docs/classes/SubtitleListBox.html +39 -39
  113. package/docs/classes/SubtitleOverlay.html +31 -31
  114. package/docs/classes/SubtitleSelectBox.html +41 -41
  115. package/docs/classes/SubtitleSettingSelectBox.html +41 -41
  116. package/docs/classes/SubtitleSettingsPanelPage.html +33 -33
  117. package/docs/classes/SubtitleSettingsResetButton.html +27 -27
  118. package/docs/classes/TitleBar.html +31 -31
  119. package/docs/classes/ToggleButton.html +35 -35
  120. package/docs/classes/ToggleSettingsPanelItem.html +34 -34
  121. package/docs/classes/TouchControlOverlay.html +32 -32
  122. package/docs/classes/TvNoiseCanvas.html +25 -25
  123. package/docs/classes/UIContainer.html +31 -31
  124. package/docs/classes/UIInstanceManager.html +16 -16
  125. package/docs/classes/UIManager.html +17 -17
  126. package/docs/classes/UIPreferencesManager.html +5 -5
  127. package/docs/classes/VRToggleButton.html +35 -35
  128. package/docs/classes/VideoQualitySelectBox.html +42 -42
  129. package/docs/classes/VolumeControlButton.html +33 -33
  130. package/docs/classes/VolumeSlider.html +36 -36
  131. package/docs/classes/VolumeToggleButton.html +35 -35
  132. package/docs/classes/Watermark.html +28 -28
  133. package/docs/classes/WindowColorSelectBox.html +41 -41
  134. package/docs/classes/WindowOpacitySelectBox.html +41 -41
  135. package/docs/enums/ButtonStyle.html +5 -5
  136. package/docs/enums/LabelStyle.html +4 -4
  137. package/docs/enums/MetadataLabelContent.html +3 -3
  138. package/docs/enums/NavigationDirection.html +2 -2
  139. package/docs/enums/PlaybackTimeLabelMode.html +5 -5
  140. package/docs/enums/PlayerUtils.PlayerState.html +2 -2
  141. package/docs/enums/UIComponentLayoutOverride.html +2 -2
  142. package/docs/enums/UIUtils.KeyCode.html +2 -2
  143. package/docs/enums/UIVariantIdentifier.html +2 -2
  144. package/docs/enums/ViewMode.html +3 -3
  145. package/docs/functions/ArrayUtils.remove.html +1 -1
  146. package/docs/functions/ErrorUtils.defaultMobileV3ErrorMessageTranslator.html +1 -1
  147. package/docs/functions/PlayerUtils.clampValueToRange.html +1 -1
  148. package/docs/functions/PlayerUtils.getCurrentTimeRelativeToSeekableRange.html +1 -1
  149. package/docs/functions/PlayerUtils.getSeekableRangeRespectingLive.html +1 -1
  150. package/docs/functions/PlayerUtils.getSeekableRangeStart.html +1 -1
  151. package/docs/functions/PlayerUtils.getState.html +1 -1
  152. package/docs/functions/PlayerUtils.isTimeShiftAvailable.html +1 -1
  153. package/docs/functions/StorageUtils.getItem.html +1 -1
  154. package/docs/functions/StorageUtils.getObject.html +1 -1
  155. package/docs/functions/StorageUtils.removeItem.html +1 -1
  156. package/docs/functions/StorageUtils.setItem.html +1 -1
  157. package/docs/functions/StorageUtils.setObject.html +1 -1
  158. package/docs/functions/StorageUtils.setStorageApiDisabled.html +1 -1
  159. package/docs/functions/StringUtils.replaceAdMessagePlaceholders.html +1 -1
  160. package/docs/functions/StringUtils.secondsToText.html +1 -1
  161. package/docs/functions/StringUtils.secondsToTime.html +1 -1
  162. package/docs/functions/UIFactory.buildCastReceiverUI.html +1 -1
  163. package/docs/functions/UIFactory.buildSmallScreenUI.html +1 -1
  164. package/docs/functions/UIFactory.buildSubtitleUI.html +1 -1
  165. package/docs/functions/UIFactory.buildTvUI.html +1 -1
  166. package/docs/functions/UIFactory.buildUI.html +1 -1
  167. package/docs/functions/UIFactory.defaultLayouts.ads.html +1 -1
  168. package/docs/functions/UIFactory.defaultLayouts.castReceiver.html +1 -1
  169. package/docs/functions/UIFactory.defaultLayouts.emptyState.html +1 -1
  170. package/docs/functions/UIFactory.defaultLayouts.main.html +1 -1
  171. package/docs/functions/UIFactory.defaultLayouts.smallScreen.html +1 -1
  172. package/docs/functions/UIFactory.defaultLayouts.smallScreenAds.html +1 -1
  173. package/docs/functions/UIFactory.defaultLayouts.subtitle.html +1 -1
  174. package/docs/functions/UIFactory.defaultLayouts.tv.html +1 -1
  175. package/docs/functions/UIFactory.defaultLayouts.tvAds.html +1 -1
  176. package/docs/functions/UIUtils.traverseTree.html +1 -1
  177. package/docs/hierarchy.html +1 -1
  178. package/docs/interfaces/ActiveUiChangedArgs.html +3 -3
  179. package/docs/interfaces/AdControlBarConfig.html +12 -12
  180. package/docs/interfaces/AdSkipButtonConfig.html +16 -16
  181. package/docs/interfaces/AudioTrackListBoxConfig.html +19 -19
  182. package/docs/interfaces/BufferingOverlayConfig.html +13 -13
  183. package/docs/interfaces/ButtonConfig.html +14 -14
  184. package/docs/interfaces/ClickOverlayConfig.html +15 -15
  185. package/docs/interfaces/CloseButtonConfig.html +15 -15
  186. package/docs/interfaces/ComponentConfig.html +11 -11
  187. package/docs/interfaces/ComponentFocusChangedEventArgs.html +2 -2
  188. package/docs/interfaces/ComponentHoverChangedEventArgs.html +2 -2
  189. package/docs/interfaces/ContainerConfig.html +12 -12
  190. package/docs/interfaces/ContextMenuConfig.html +17 -17
  191. package/docs/interfaces/ControlBarConfig.html +12 -12
  192. package/docs/interfaces/DismissClickOverlayConfig.html +14 -14
  193. package/docs/interfaces/DynamicSettingsPanelItemConfig.html +19 -19
  194. package/docs/interfaces/ErrorMessageMap.html +1 -1
  195. package/docs/interfaces/ErrorMessageOverlayConfig.html +13 -13
  196. package/docs/interfaces/ErrorMessageTranslator.html +1 -1
  197. package/docs/interfaces/ExternalRecommendationLink.html +3 -3
  198. package/docs/interfaces/InteractiveContextMenuItemConfig.html +18 -18
  199. package/docs/interfaces/InternalUIConfig.html +26 -26
  200. package/docs/interfaces/LabelConfig.html +14 -14
  201. package/docs/interfaces/ListBoxConfig.html +20 -20
  202. package/docs/interfaces/ListItem.html +2 -2
  203. package/docs/interfaces/ListItemFilter.html +1 -1
  204. package/docs/interfaces/ListItemLabelTranslator.html +1 -1
  205. package/docs/interfaces/ListSelectorConfig.html +12 -12
  206. package/docs/interfaces/LocalizationConfig.html +5 -5
  207. package/docs/interfaces/MetadataLabelConfig.html +15 -15
  208. package/docs/interfaces/PlaybackTimeLabelConfig.html +16 -16
  209. package/docs/interfaces/PlaybackToggleButtonConfig.html +19 -19
  210. package/docs/interfaces/PlaybackToggleOverlayConfig.html +13 -13
  211. package/docs/interfaces/PlayerContextMenuConfig.html +18 -18
  212. package/docs/interfaces/PlayerInsightsPanelConfig.html +18 -18
  213. package/docs/interfaces/PlayerUtils.LiveStreamDetectorEventArgs.html +2 -2
  214. package/docs/interfaces/PlayerUtils.TimeShiftAvailabilityChangedArgs.html +2 -2
  215. package/docs/interfaces/QuickSeekButtonConfig.html +15 -15
  216. package/docs/interfaces/RecommendationConfig.html +4 -4
  217. package/docs/interfaces/RecommendationItemConfig.html +12 -12
  218. package/docs/interfaces/RecommendationsApi.html +4 -4
  219. package/docs/interfaces/SeekBarConfig.html +19 -19
  220. package/docs/interfaces/SeekBarLabelConfig.html +12 -12
  221. package/docs/interfaces/SeekBarMarker.html +2 -2
  222. package/docs/interfaces/SeekPreviewArgs.html +3 -3
  223. package/docs/interfaces/SeekPreviewEventArgs.html +4 -4
  224. package/docs/interfaces/SettingsPanelConfig.html +17 -17
  225. package/docs/interfaces/SettingsPanelItemConfig.html +17 -17
  226. package/docs/interfaces/SettingsPanelPageConfig.html +13 -13
  227. package/docs/interfaces/SettingsPanelPageNavigatorConfig.html +17 -17
  228. package/docs/interfaces/SettingsPanelSelectOptionConfig.html +18 -18
  229. package/docs/interfaces/SettingsPanelSeparatorConfig.html +12 -12
  230. package/docs/interfaces/SettingsPanelState.html +2 -2
  231. package/docs/interfaces/SettingsToggleButtonConfig.html +20 -20
  232. package/docs/interfaces/ShadowDomConfig.html +4 -4
  233. package/docs/interfaces/SubtitleListBoxConfig.html +19 -19
  234. package/docs/interfaces/SubtitleOverlayConfig.html +14 -14
  235. package/docs/interfaces/SubtitleSettingSelectBoxConfig.html +12 -12
  236. package/docs/interfaces/SubtitleSettingsPanelPageConfig.html +13 -13
  237. package/docs/interfaces/TimelineMarker.html +6 -6
  238. package/docs/interfaces/TimelineMarkersApi.html +4 -4
  239. package/docs/interfaces/TitleBarConfig.html +13 -13
  240. package/docs/interfaces/ToggleButtonConfig.html +18 -18
  241. package/docs/interfaces/ToggleSettingsPanelItemConfig.html +17 -17
  242. package/docs/interfaces/TouchControlOverlayConfig.html +22 -17
  243. package/docs/interfaces/UIComponentConfigMap.html +3 -2
  244. package/docs/interfaces/UIComponentConfigOverrides.html +11 -10
  245. package/docs/interfaces/UIComponentLayoutOverrideMap.html +3 -2
  246. package/docs/interfaces/UIComponentLayoutOverrides.html +11 -10
  247. package/docs/interfaces/UIConditionContext.html +10 -10
  248. package/docs/interfaces/UIConditionResolver.html +1 -1
  249. package/docs/interfaces/UIConfig.html +24 -24
  250. package/docs/interfaces/UIContainerConfig.html +17 -17
  251. package/docs/interfaces/UIUtils.TreeTraversalCallback.html +1 -1
  252. package/docs/interfaces/UIVariant.html +5 -5
  253. package/docs/interfaces/UIVariantFactory.html +4 -4
  254. package/docs/interfaces/ViewModeChangedEventArgs.html +2 -2
  255. package/docs/interfaces/Vocabularies.html +1 -1
  256. package/docs/interfaces/Vocabulary.html +2 -2
  257. package/docs/interfaces/VolumeControlButtonConfig.html +14 -14
  258. package/docs/interfaces/VolumeSliderConfig.html +21 -21
  259. package/docs/interfaces/WatermarkConfig.html +15 -15
  260. package/docs/interfaces/WrappedPlayer.html +2 -2
  261. package/docs/media/CHANGELOG.md +7 -0
  262. package/docs/modules.html +1 -1
  263. package/docs/types/CustomVocabulary.html +1 -1
  264. package/docs/types/ListItemComparator.html +1 -1
  265. package/docs/types/LocalizableText.html +1 -1
  266. package/docs/types/Localizer.html +1 -1
  267. package/docs/variables/ErrorUtils.defaultErrorMessages.html +1 -1
  268. package/docs/variables/ErrorUtils.defaultWebErrorMessageTranslator.html +1 -1
  269. package/docs/variables/StringUtils.FORMAT_HHMMSS.html +1 -1
  270. package/docs/variables/StringUtils.FORMAT_MMSS.html +1 -1
  271. package/docs/variables/i18n.html +1 -1
  272. package/docs/variables/version.html +1 -1
  273. package/package.json +1 -1
  274. package/src/scss/bitmovinplayer-ui.scss +1 -0
  275. package/src/scss/components/ads/_pause-ad-status-overlay.scss +111 -0
  276. package/src/ts/UIComponentConfigOverrides.ts +4 -0
  277. package/src/ts/UIComponentLayoutOverrides.ts +4 -0
  278. package/src/ts/UIFactory.ts +19 -1
  279. package/src/ts/UIManager.ts +27 -0
  280. package/src/ts/components/ads/PauseAdStatusOverlay.ts +184 -0
  281. package/src/ts/components/overlays/TouchControlOverlay.ts +38 -2
  282. package/src/ts/main.ts +1 -0
  283. package/src/ts/spatialnavigation/NavigationGroup.ts +13 -2
  284. package/src/ts/spatialnavigation/PauseAdNavigationGroup.ts +49 -0
  285. package/src/ts/spatialnavigation/SeekBarHandler.ts +2 -2
  286. package/src/ts/utils/NonLinearAdEvents.ts +7 -0
  287. package/test/browser/harness.ts +190 -11
  288. package/test/browser/helpers/tv.ts +45 -0
  289. package/test/browser/pause-ad-click-routing.pw.ts +140 -0
  290. package/test/browser/pause-ad-mobile-controls.pw.ts +170 -0
  291. package/test/browser/pause-ad-tv-controls.pw.ts +257 -0
package/CHANGELOG.md CHANGED
@@ -5,6 +5,13 @@ 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.22.0] - 2026-09-25
9
+
10
+ ### Added
11
+
12
+ - `PauseAdStatusOverlay` to show an Ad badge and a Close button over pause ads in the default, small-screen, and TV layouts. Clicking the creative opens its click-through while the player controls stay usable.
13
+ - `TouchControlOverlayConfig.singleTapAction` and `PauseAdStatusOverlay.getClickThroughAction()` to open a pause-ad click-through on a single tap without breaking double-tap seeking.
14
+
8
15
  ## [4.21.1] - 2026-09-17
9
16
 
10
17
  ### Fixed