bitmovin-player-ui 4.2.0 → 4.3.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.
- package/CHANGELOG.md +20 -0
- package/dist/js/bitmovinplayer-ui.js +1 -1
- package/dist/js/bitmovinplayer-ui.js.map +1 -1
- package/dist/js/framework/UIFactory.js +1 -2
- package/dist/js/framework/components/Container.d.ts +1 -1
- package/dist/js/framework/components/UIContainer.d.ts +7 -1
- package/dist/js/framework/components/UIContainer.js +33 -2
- package/dist/js/framework/components/ads/AdMessageLabel.d.ts +22 -3
- package/dist/js/framework/components/ads/AdMessageLabel.js +40 -17
- package/dist/js/framework/components/overlays/DismissClickOverlay.js +7 -1
- package/dist/js/framework/components/settings/SettingsPanel.d.ts +28 -1
- package/dist/js/framework/components/settings/SettingsPanel.js +103 -7
- package/dist/js/framework/utils/StringUtils.d.ts +2 -2
- package/docs/assets/hierarchy.js +1 -1
- package/docs/assets/search.js +1 -1
- package/docs/classes/AdClickOverlay.html +28 -28
- package/docs/classes/AdControlBar.html +31 -31
- package/docs/classes/AdCounterLabel.html +31 -31
- package/docs/classes/AdMessageLabel.html +51 -32
- package/docs/classes/AdSkipButton.html +27 -27
- package/docs/classes/AdStatusOverlay.html +31 -31
- package/docs/classes/AirPlayToggleButton.html +35 -35
- package/docs/classes/AudioQualitySelectBox.html +38 -38
- package/docs/classes/AudioTrackListBox.html +40 -39
- package/docs/classes/AudioTrackSelectBox.html +38 -38
- package/docs/classes/BackgroundColorSelectBox.html +38 -38
- package/docs/classes/BackgroundOpacitySelectBox.html +38 -38
- package/docs/classes/BrowserUtils.html +2 -2
- package/docs/classes/BufferingOverlay.html +31 -31
- package/docs/classes/Button.html +27 -27
- package/docs/classes/CastStatusOverlay.html +31 -31
- package/docs/classes/CastToggleButton.html +35 -35
- package/docs/classes/CastUIContainer.html +31 -31
- package/docs/classes/CharacterEdgeSelectBox.html +38 -38
- package/docs/classes/ClickOverlay.html +28 -28
- package/docs/classes/CloseButton.html +27 -27
- package/docs/classes/Component.html +25 -25
- package/docs/classes/Container.html +31 -31
- package/docs/classes/ControlBar.html +31 -31
- package/docs/classes/DynamicSettingsPanelItem.html +33 -33
- package/docs/classes/ErrorMessageOverlay.html +31 -31
- package/docs/classes/FontColorSelectBox.html +38 -38
- package/docs/classes/FontFamilySelectBox.html +38 -38
- package/docs/classes/FontOpacitySelectBox.html +38 -38
- package/docs/classes/FontSizeSelectBox.html +38 -38
- package/docs/classes/FullscreenToggleButton.html +35 -35
- package/docs/classes/HugePlaybackToggleButton.html +35 -35
- package/docs/classes/HugeReplayButton.html +27 -27
- package/docs/classes/I18n.html +2 -2
- package/docs/classes/Icon.html +25 -25
- package/docs/classes/ItemSelectionList.html +38 -38
- package/docs/classes/Label.html +31 -31
- package/docs/classes/ListBox.html +40 -39
- package/docs/classes/ListSelector.html +38 -38
- package/docs/classes/MetadataLabel.html +31 -31
- package/docs/classes/NavigationGroup.html +10 -10
- package/docs/classes/PictureInPictureToggleButton.html +35 -35
- package/docs/classes/PlaybackSpeedSelectBox.html +38 -38
- package/docs/classes/PlaybackTimeLabel.html +32 -32
- package/docs/classes/PlaybackToggleButton.html +35 -35
- package/docs/classes/PlaybackToggleOverlay.html +31 -31
- package/docs/classes/PlayerUtils.LiveStreamDetector.html +2 -2
- package/docs/classes/PlayerUtils.TimeShiftAvailabilityDetector.html +2 -2
- package/docs/classes/PlayerWrapper.html +4 -4
- package/docs/classes/QuickSeekButton.html +27 -27
- package/docs/classes/RecommendationItem.html +25 -25
- package/docs/classes/RecommendationOverlay.html +31 -31
- package/docs/classes/ReplayButton.html +27 -27
- package/docs/classes/RootNavigationGroup.html +10 -10
- package/docs/classes/SeekBar.html +36 -36
- package/docs/classes/SeekBarLabel.html +35 -35
- package/docs/classes/SelectBox.html +38 -38
- package/docs/classes/SettingsPanel.html +40 -39
- package/docs/classes/SettingsPanelItem.html +33 -33
- package/docs/classes/SettingsPanelNavigationGroup.html +10 -10
- package/docs/classes/SettingsPanelNavigationGroupConfig.html +2 -2
- package/docs/classes/SettingsPanelPage.html +33 -33
- package/docs/classes/SettingsPanelPageBackButton.html +29 -29
- package/docs/classes/SettingsPanelPageOpenButton.html +29 -29
- package/docs/classes/SettingsToggleButton.html +35 -35
- package/docs/classes/Spacer.html +25 -25
- package/docs/classes/SpatialNavigation.html +4 -4
- package/docs/classes/SubtitleListBox.html +40 -39
- package/docs/classes/SubtitleOverlay.html +31 -31
- package/docs/classes/SubtitleSelectBox.html +38 -38
- package/docs/classes/SubtitleSettingSelectBox.html +38 -38
- package/docs/classes/SubtitleSettingsPanelPage.html +33 -33
- package/docs/classes/SubtitleSettingsResetButton.html +27 -27
- package/docs/classes/TitleBar.html +31 -31
- package/docs/classes/ToggleButton.html +35 -35
- package/docs/classes/UIContainer.html +31 -31
- package/docs/classes/UIInstanceManager.html +14 -14
- package/docs/classes/UIManager.html +14 -14
- package/docs/classes/VRToggleButton.html +35 -35
- package/docs/classes/VideoQualitySelectBox.html +39 -39
- package/docs/classes/VolumeControlButton.html +33 -33
- package/docs/classes/VolumeSlider.html +36 -36
- package/docs/classes/VolumeToggleButton.html +35 -35
- package/docs/classes/Watermark.html +28 -28
- package/docs/classes/WindowColorSelectBox.html +38 -38
- package/docs/classes/WindowOpacitySelectBox.html +38 -38
- package/docs/enums/ButtonStyle.html +5 -5
- package/docs/enums/LabelStyle.html +4 -4
- package/docs/enums/MetadataLabelContent.html +3 -3
- package/docs/enums/NavigationDirection.html +2 -2
- package/docs/enums/PlaybackTimeLabelMode.html +5 -5
- package/docs/enums/PlayerUtils.PlayerState.html +2 -2
- package/docs/enums/UIUtils.KeyCode.html +2 -2
- package/docs/enums/ViewMode.html +3 -3
- package/docs/functions/ArrayUtils.remove.html +1 -1
- package/docs/functions/ErrorUtils.defaultMobileV3ErrorMessageTranslator.html +1 -1
- package/docs/functions/PlayerUtils.clampValueToRange.html +1 -1
- package/docs/functions/PlayerUtils.getCurrentTimeRelativeToSeekableRange.html +1 -1
- package/docs/functions/PlayerUtils.getSeekableRangeRespectingLive.html +1 -1
- package/docs/functions/PlayerUtils.getSeekableRangeStart.html +1 -1
- package/docs/functions/PlayerUtils.getState.html +1 -1
- package/docs/functions/PlayerUtils.isTimeShiftAvailable.html +1 -1
- package/docs/functions/StorageUtils.getItem.html +1 -1
- package/docs/functions/StorageUtils.getObject.html +1 -1
- package/docs/functions/StorageUtils.setItem.html +1 -1
- package/docs/functions/StorageUtils.setObject.html +1 -1
- package/docs/functions/StorageUtils.setStorageApiDisabled.html +1 -1
- package/docs/functions/StringUtils.replaceAdMessagePlaceholders.html +1 -1
- package/docs/functions/StringUtils.secondsToText.html +1 -1
- package/docs/functions/StringUtils.secondsToTime.html +1 -1
- package/docs/functions/UIFactory.buildCastReceiverUI.html +1 -1
- package/docs/functions/UIFactory.buildSmallScreenUI.html +1 -1
- package/docs/functions/UIFactory.buildSubtitleUI.html +1 -1
- package/docs/functions/UIFactory.buildTvUI.html +1 -1
- package/docs/functions/UIFactory.buildUI.html +1 -1
- package/docs/functions/UIUtils.traverseTree.html +1 -1
- package/docs/hierarchy.html +1 -1
- package/docs/interfaces/ActiveUiChangedArgs.html +3 -3
- package/docs/interfaces/AdControlBarConfig.html +12 -12
- package/docs/interfaces/AdSkipButtonConfig.html +16 -16
- package/docs/interfaces/BufferingOverlayConfig.html +13 -13
- package/docs/interfaces/ButtonConfig.html +14 -14
- package/docs/interfaces/ClickOverlayConfig.html +15 -15
- package/docs/interfaces/CloseButtonConfig.html +15 -15
- package/docs/interfaces/ComponentConfig.html +11 -11
- package/docs/interfaces/ComponentFocusChangedEventArgs.html +2 -2
- package/docs/interfaces/ComponentHoverChangedEventArgs.html +2 -2
- package/docs/interfaces/ContainerConfig.html +12 -12
- package/docs/interfaces/ControlBarConfig.html +12 -12
- package/docs/interfaces/DynamicSettingsPanelItemConfig.html +19 -19
- package/docs/interfaces/ErrorMessageMap.html +1 -1
- package/docs/interfaces/ErrorMessageOverlayConfig.html +13 -13
- package/docs/interfaces/ErrorMessageTranslator.html +1 -1
- package/docs/interfaces/ExternalRecommendationLink.html +3 -3
- package/docs/interfaces/IconConfig.html +12 -12
- package/docs/interfaces/InternalUIConfig.html +15 -15
- package/docs/interfaces/LabelConfig.html +14 -14
- package/docs/interfaces/ListBoxConfig.html +22 -17
- package/docs/interfaces/ListItem.html +2 -2
- package/docs/interfaces/ListItemFilter.html +1 -1
- package/docs/interfaces/ListItemLabelTranslator.html +1 -1
- package/docs/interfaces/ListSelectorConfig.html +11 -11
- package/docs/interfaces/LocalizationConfig.html +3 -3
- package/docs/interfaces/MetadataLabelConfig.html +15 -15
- package/docs/interfaces/PlaybackTimeLabelConfig.html +16 -16
- package/docs/interfaces/PlaybackToggleButtonConfig.html +19 -19
- package/docs/interfaces/PlaybackToggleOverlayConfig.html +13 -13
- package/docs/interfaces/PlayerUtils.LiveStreamDetectorEventArgs.html +2 -2
- package/docs/interfaces/PlayerUtils.TimeShiftAvailabilityChangedArgs.html +2 -2
- package/docs/interfaces/QuickSeekButtonConfig.html +15 -15
- package/docs/interfaces/RecommendationConfig.html +4 -4
- package/docs/interfaces/RecommendationItemConfig.html +12 -12
- package/docs/interfaces/SeekBarConfig.html +19 -19
- package/docs/interfaces/SeekBarLabelConfig.html +12 -12
- package/docs/interfaces/SeekBarMarker.html +2 -2
- package/docs/interfaces/SeekPreviewArgs.html +3 -3
- package/docs/interfaces/SeekPreviewEventArgs.html +4 -4
- package/docs/interfaces/SettingsPanelConfig.html +20 -15
- package/docs/interfaces/SettingsPanelItemConfig.html +17 -17
- package/docs/interfaces/SettingsPanelPageConfig.html +13 -13
- package/docs/interfaces/SettingsToggleButtonConfig.html +20 -20
- package/docs/interfaces/SubtitleSettingSelectBoxConfig.html +11 -11
- package/docs/interfaces/SubtitleSettingsPanelPageConfig.html +13 -13
- package/docs/interfaces/TimelineMarker.html +6 -6
- package/docs/interfaces/TitleBarConfig.html +13 -13
- package/docs/interfaces/ToggleButtonConfig.html +18 -18
- package/docs/interfaces/UIConditionContext.html +10 -10
- package/docs/interfaces/UIConditionResolver.html +1 -1
- package/docs/interfaces/UIConfig.html +14 -14
- package/docs/interfaces/UIContainerConfig.html +20 -16
- package/docs/interfaces/UIUtils.TreeTraversalCallback.html +1 -1
- package/docs/interfaces/UIVariant.html +2 -2
- package/docs/interfaces/ViewModeChangedEventArgs.html +2 -2
- package/docs/interfaces/Vocabularies.html +1 -1
- package/docs/interfaces/Vocabulary.html +2 -2
- package/docs/interfaces/VolumeControlButtonConfig.html +14 -14
- package/docs/interfaces/VolumeSliderConfig.html +21 -21
- package/docs/interfaces/WatermarkConfig.html +15 -15
- package/docs/interfaces/WrappedPlayer.html +2 -2
- package/docs/media/CHANGELOG.md +20 -0
- package/docs/types/CustomVocabulary.html +1 -1
- package/docs/types/LocalizableText.html +1 -1
- package/docs/types/Localizer.html +1 -1
- package/docs/variables/ErrorUtils.defaultErrorMessages.html +1 -1
- package/docs/variables/ErrorUtils.defaultWebErrorMessageTranslator.html +1 -1
- package/docs/variables/StringUtils.FORMAT_HHMMSS.html +1 -1
- package/docs/variables/StringUtils.FORMAT_MMSS.html +1 -1
- package/docs/variables/i18n.html +1 -1
- package/docs/variables/version.html +1 -1
- package/package.json +1 -1
- package/src/ts/DOM.ts +18 -18
- package/src/ts/EventDispatcher.ts +5 -5
- package/src/ts/UIFactory.ts +8 -9
- package/src/ts/UIManager.ts +29 -29
- package/src/ts/components/CastUIContainer.ts +6 -6
- package/src/ts/components/Component.ts +3 -3
- package/src/ts/components/Container.ts +5 -5
- package/src/ts/components/RecommendationItem.ts +2 -2
- package/src/ts/components/TvNoiseCanvas.ts +3 -3
- package/src/ts/components/UIContainer.ts +57 -14
- package/src/ts/components/ads/AdClickOverlay.ts +2 -2
- package/src/ts/components/ads/AdMessageLabel.ts +47 -20
- package/src/ts/components/ads/AdSkipButton.ts +5 -5
- package/src/ts/components/buttons/Button.ts +1 -1
- package/src/ts/components/buttons/CastToggleButton.ts +1 -1
- package/src/ts/components/buttons/CloseButton.ts +1 -1
- package/src/ts/components/buttons/HugePlaybackToggleButton.ts +3 -3
- package/src/ts/components/buttons/PlaybackToggleButton.ts +3 -3
- package/src/ts/components/buttons/QuickSeekButton.ts +1 -1
- package/src/ts/components/buttons/SmallCenteredPlaybackToggleButton.ts +1 -1
- package/src/ts/components/buttons/VRToggleButton.ts +4 -4
- package/src/ts/components/buttons/VolumeControlButton.ts +2 -2
- package/src/ts/components/labels/Label.ts +1 -1
- package/src/ts/components/labels/MetadataLabel.ts +4 -4
- package/src/ts/components/labels/PlaybackTimeLabel.ts +13 -13
- package/src/ts/components/lists/ItemSelectionList.ts +3 -3
- package/src/ts/components/lists/ListSelector.ts +4 -4
- package/src/ts/components/overlays/CastStatusOverlay.ts +2 -2
- package/src/ts/components/overlays/ClickOverlay.ts +1 -1
- package/src/ts/components/overlays/DismissClickOverlay.ts +7 -2
- package/src/ts/components/overlays/ErrorMessageOverlay.ts +2 -2
- package/src/ts/components/overlays/RecommendationOverlay.ts +2 -2
- package/src/ts/components/overlays/SubtitleOverlay.ts +10 -10
- package/src/ts/components/seekbar/SeekBar.ts +37 -37
- package/src/ts/components/seekbar/SeekBarLabel.ts +15 -15
- package/src/ts/components/seekbar/VolumeSlider.ts +1 -1
- package/src/ts/components/settings/AudioQualitySelectBox.ts +4 -4
- package/src/ts/components/settings/DynamicSettingsPanelItem.ts +3 -3
- package/src/ts/components/settings/SelectBox.ts +3 -3
- package/src/ts/components/settings/SettingsPanel.ts +137 -10
- package/src/ts/components/settings/SettingsPanelItem.ts +1 -1
- package/src/ts/components/settings/SettingsPanelPage.ts +4 -4
- package/src/ts/components/settings/SettingsPanelSelectOption.ts +1 -1
- package/src/ts/components/settings/SettingsToggleButton.ts +3 -3
- package/src/ts/components/settings/VideoQualitySelectBox.ts +4 -4
- package/src/ts/components/settings/subtitlesettings/BackgroundColorSelectBox.ts +1 -1
- package/src/ts/components/settings/subtitlesettings/FontColorSelectBox.ts +1 -1
- package/src/ts/components/settings/subtitlesettings/WindowColorSelectBox.ts +1 -1
- package/src/ts/main.ts +2 -2
- package/src/ts/spatialnavigation/NavigationGroup.ts +2 -2
- package/src/ts/spatialnavigation/SettingsPanelNavigationGroup.ts +1 -1
- package/src/ts/utils/ArrayUtils.ts +1 -1
- package/src/ts/utils/AudioTrackUtils.ts +1 -1
- package/src/ts/utils/ImageLoader.ts +2 -2
- package/src/ts/utils/PlayerUtils.ts +4 -4
- package/src/ts/utils/StorageUtils.ts +3 -3
- package/src/ts/utils/StringUtils.ts +17 -17
- package/src/ts/utils/SubtitleSettingsManager.ts +3 -3
- package/src/ts/utils/SubtitleUtils.ts +1 -1
- package/src/ts/utils/UIUtils.ts +2 -2
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>PlaybackTimeLabelConfig | bitmovin-player-ui</title><meta name="description" content="Documentation for bitmovin-player-ui"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">bitmovin-player-ui</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">PlaybackTimeLabelConfig</a></li></ul><h1>Interface PlaybackTimeLabelConfig</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">PlaybackTimeLabelConfig</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#arialabel">ariaLabel</a><span class="tsd-signature-symbol">?:</span> <a href="../types/LocalizableText.html" class="tsd-signature-type tsd-kind-type-alias">LocalizableText</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#cssclass">cssClass</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#cssclasses">cssClasses</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#cssprefix">cssPrefix</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#disabled">disabled</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#for">for</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#hidden">hidden</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#hideinliveplayback">hideInLivePlayback</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#id">id</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#labelstyle">labelStyle</a><span class="tsd-signature-symbol">?:</span> <a href="../enums/LabelStyle.html" class="tsd-signature-type tsd-kind-enum">LabelStyle</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#role">role</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#tabindex">tabIndex</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#tag">tag</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#text">text</a><span class="tsd-signature-symbol">?:</span> <a href="../types/LocalizableText.html" class="tsd-signature-type tsd-kind-type-alias">LocalizableText</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#timelabelmode">timeLabelMode</a><span class="tsd-signature-symbol">?:</span> <a href="../enums/PlaybackTimeLabelMode.html" class="tsd-signature-type tsd-kind-enum">PlaybackTimeLabelMode</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy" data-refl="
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>PlaybackTimeLabelConfig | bitmovin-player-ui</title><meta name="description" content="Documentation for bitmovin-player-ui"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">bitmovin-player-ui</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">PlaybackTimeLabelConfig</a></li></ul><h1>Interface PlaybackTimeLabelConfig</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">PlaybackTimeLabelConfig</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#arialabel">ariaLabel</a><span class="tsd-signature-symbol">?:</span> <a href="../types/LocalizableText.html" class="tsd-signature-type tsd-kind-type-alias">LocalizableText</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#cssclass">cssClass</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#cssclasses">cssClasses</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#cssprefix">cssPrefix</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#disabled">disabled</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#for">for</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#hidden">hidden</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#hideinliveplayback">hideInLivePlayback</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#id">id</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#labelstyle">labelStyle</a><span class="tsd-signature-symbol">?:</span> <a href="../enums/LabelStyle.html" class="tsd-signature-type tsd-kind-enum">LabelStyle</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#role">role</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#tabindex">tabIndex</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#tag">tag</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#text">text</a><span class="tsd-signature-symbol">?:</span> <a href="../types/LocalizableText.html" class="tsd-signature-type tsd-kind-type-alias">LocalizableText</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#timelabelmode">timeLabelMode</a><span class="tsd-signature-symbol">?:</span> <a href="../enums/PlaybackTimeLabelMode.html" class="tsd-signature-type tsd-kind-enum">PlaybackTimeLabelMode</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy" data-refl="1514"><h4>Hierarchy (<a href="../hierarchy.html#PlaybackTimeLabelConfig">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="LabelConfig.html" class="tsd-signature-type tsd-kind-interface">LabelConfig</a><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">PlaybackTimeLabelConfig</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/labels/PlaybackTimeLabel.ts#L32">src/ts/components/labels/PlaybackTimeLabel.ts:32</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#arialabel" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>aria<wbr/>Label?</span></a>
|
|
2
2
|
<a href="#cssclass" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>css<wbr/>Class?</span></a>
|
|
3
3
|
<a href="#cssclasses" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>css<wbr/>Classes?</span></a>
|
|
4
4
|
<a href="#cssprefix" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>css<wbr/>Prefix?</span></a>
|
|
@@ -14,24 +14,24 @@
|
|
|
14
14
|
<a href="#text" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>text?</span></a>
|
|
15
15
|
<a href="#timelabelmode" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>time<wbr/>Label<wbr/>Mode?</span></a>
|
|
16
16
|
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="arialabel"><code class="tsd-tag">Optional</code><span>aria<wbr/>Label</span><a href="#arialabel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ariaLabel</span><span class="tsd-signature-symbol">?:</span> <a href="../types/LocalizableText.html" class="tsd-signature-type tsd-kind-type-alias">LocalizableText</a></div><div class="tsd-comment tsd-typography"><p>WCAG20 standard for defining info about the component (usually the name)</p>
|
|
17
|
-
</div><aside class="tsd-sources"><p>Inherited from <a href="LabelConfig.html">LabelConfig</a>.<a href="LabelConfig.html#arialabel">ariaLabel</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
18
|
-
</div><aside class="tsd-sources"><p>Inherited from <a href="LabelConfig.html">LabelConfig</a>.<a href="LabelConfig.html#cssclass">cssClass</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
19
|
-
</div><aside class="tsd-sources"><p>Inherited from <a href="LabelConfig.html">LabelConfig</a>.<a href="LabelConfig.html#cssclasses">cssClasses</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
20
|
-
</div><aside class="tsd-sources"><p>Inherited from <a href="LabelConfig.html">LabelConfig</a>.<a href="LabelConfig.html#cssprefix">cssPrefix</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
17
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="LabelConfig.html">LabelConfig</a>.<a href="LabelConfig.html#arialabel">ariaLabel</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/Component.ts#L66">src/ts/components/Component.ts:66</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="cssclass"><code class="tsd-tag">Optional</code><span>css<wbr/>Class</span><a href="#cssclass" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cssClass</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The CSS classes of the component. This is usually the class from where the component takes its styling.</p>
|
|
18
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="LabelConfig.html">LabelConfig</a>.<a href="LabelConfig.html#cssclass">cssClass</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/Component.ts#L34">src/ts/components/Component.ts:34</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="cssclasses"><code class="tsd-tag">Optional</code><span>css<wbr/>Classes</span><a href="#cssclasses" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cssClasses</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Additional CSS classes of the component.</p>
|
|
19
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="LabelConfig.html">LabelConfig</a>.<a href="LabelConfig.html#cssclasses">cssClasses</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/Component.ts#L39">src/ts/components/Component.ts:39</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="cssprefix"><code class="tsd-tag">Optional</code><span>css<wbr/>Prefix</span><a href="#cssprefix" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cssPrefix</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>A prefix to prepend all CSS classes with.</p>
|
|
20
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="LabelConfig.html">LabelConfig</a>.<a href="LabelConfig.html#cssprefix">cssPrefix</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/Component.ts#L29">src/ts/components/Component.ts:29</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="disabled"><code class="tsd-tag">Optional</code><span>disabled</span><a href="#disabled" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">disabled</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Specifies if the component is enabled (interactive) or not.
|
|
21
21
|
Default: false</p>
|
|
22
|
-
</div><aside class="tsd-sources"><p>Inherited from <a href="LabelConfig.html">LabelConfig</a>.<a href="LabelConfig.html#disabled">disabled</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
23
|
-
</div><aside class="tsd-sources"><p>Inherited from <a href="LabelConfig.html">LabelConfig</a>.<a href="LabelConfig.html#for">for</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
22
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="LabelConfig.html">LabelConfig</a>.<a href="LabelConfig.html#disabled">disabled</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/Component.ts#L51">src/ts/components/Component.ts:51</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="for"><code class="tsd-tag">Optional</code><span>for</span><a href="#for" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">for</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>WCAG20 standard: Associate label to form control.</p>
|
|
23
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="LabelConfig.html">LabelConfig</a>.<a href="LabelConfig.html#for">for</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/labels/Label.ts#L38">src/ts/components/labels/Label.ts:38</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="hidden"><code class="tsd-tag">Optional</code><span>hidden</span><a href="#hidden" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">hidden</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Specifies if the component should be hidden at startup.
|
|
24
24
|
Default: false</p>
|
|
25
|
-
</div><aside class="tsd-sources"><p>Inherited from <a href="LabelConfig.html">LabelConfig</a>.<a href="LabelConfig.html#hidden">hidden</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
26
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
25
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="LabelConfig.html">LabelConfig</a>.<a href="LabelConfig.html#hidden">hidden</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/Component.ts#L45">src/ts/components/Component.ts:45</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="hideinliveplayback"><code class="tsd-tag">Optional</code><span>hide<wbr/>In<wbr/>Live<wbr/>Playback</span><a href="#hideinliveplayback" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">hideInLivePlayback</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Boolean if the label should be hidden in live playback</p>
|
|
26
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/labels/PlaybackTimeLabel.ts#L41">src/ts/components/labels/PlaybackTimeLabel.ts:41</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="id"><code class="tsd-tag">Optional</code><span>id</span><a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The HTML ID of the component.
|
|
27
27
|
Default: automatically generated with pattern 'ui-id-{guid}'.</p>
|
|
28
|
-
</div><aside class="tsd-sources"><p>Inherited from <a href="LabelConfig.html">LabelConfig</a>.<a href="LabelConfig.html#id">id</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
28
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="LabelConfig.html">LabelConfig</a>.<a href="LabelConfig.html#id">id</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/Component.ts#L24">src/ts/components/Component.ts:24</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="labelstyle"><code class="tsd-tag">Optional</code><span>label<wbr/>Style</span><a href="#labelstyle" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">labelStyle</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/LabelStyle.html" class="tsd-signature-type tsd-kind-enum">LabelStyle</a></div><div class="tsd-comment tsd-typography"><p>The style of the label.
|
|
29
29
|
Default: <a href="../enums/LabelStyle.html#text" class="tsd-kind-enum-member">LabelStyle.Text</a></p>
|
|
30
|
-
</div><aside class="tsd-sources"><p>Inherited from <a href="LabelConfig.html">LabelConfig</a>.<a href="LabelConfig.html#labelstyle">labelStyle</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
31
|
-
</div><aside class="tsd-sources"><p>Inherited from <a href="LabelConfig.html">LabelConfig</a>.<a href="LabelConfig.html#role">role</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
32
|
-
</div><aside class="tsd-sources"><p>Inherited from <a href="LabelConfig.html">LabelConfig</a>.<a href="LabelConfig.html#tabindex">tabIndex</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
30
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="LabelConfig.html">LabelConfig</a>.<a href="LabelConfig.html#labelstyle">labelStyle</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/labels/Label.ts#L44">src/ts/components/labels/Label.ts:44</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="role"><code class="tsd-tag">Optional</code><span>role</span><a href="#role" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">role</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Specifies the component role for WCAG20 standard</p>
|
|
31
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="LabelConfig.html">LabelConfig</a>.<a href="LabelConfig.html#role">role</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/Component.ts#L56">src/ts/components/Component.ts:56</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="tabindex"><code class="tsd-tag">Optional</code><span>tab<wbr/>Index</span><a href="#tabindex" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">tabIndex</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>WCAG20 requirement for screen reader navigation</p>
|
|
32
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="LabelConfig.html">LabelConfig</a>.<a href="LabelConfig.html#tabindex">tabIndex</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/Component.ts#L61">src/ts/components/Component.ts:61</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="tag"><code class="tsd-tag">Optional</code><span>tag</span><a href="#tag" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">tag</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The HTML tag name of the component.
|
|
33
33
|
Default: 'div'</p>
|
|
34
|
-
</div><aside class="tsd-sources"><p>Inherited from <a href="LabelConfig.html">LabelConfig</a>.<a href="LabelConfig.html#tag">tag</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
35
|
-
</div><aside class="tsd-sources"><p>Inherited from <a href="LabelConfig.html">LabelConfig</a>.<a href="LabelConfig.html#text">text</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
34
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="LabelConfig.html">LabelConfig</a>.<a href="LabelConfig.html#tag">tag</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/Component.ts#L19">src/ts/components/Component.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="text"><code class="tsd-tag">Optional</code><span>text</span><a href="#text" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">text</span><span class="tsd-signature-symbol">?:</span> <a href="../types/LocalizableText.html" class="tsd-signature-type tsd-kind-type-alias">LocalizableText</a></div><div class="tsd-comment tsd-typography"><p>The text as string or localize callback on the label.</p>
|
|
35
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="LabelConfig.html">LabelConfig</a>.<a href="LabelConfig.html#text">text</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/labels/Label.ts#L33">src/ts/components/labels/Label.ts:33</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="timelabelmode"><code class="tsd-tag">Optional</code><span>time<wbr/>Label<wbr/>Mode</span><a href="#timelabelmode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">timeLabelMode</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/PlaybackTimeLabelMode.html" class="tsd-signature-type tsd-kind-enum">PlaybackTimeLabelMode</a></div><div class="tsd-comment tsd-typography"><p>The type of which time should be displayed in the label.
|
|
36
36
|
Default: PlaybackTimeLabelMode.CurrentAndTotalTime</p>
|
|
37
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
37
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/labels/PlaybackTimeLabel.ts#L37">src/ts/components/labels/PlaybackTimeLabel.ts:37</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#arialabel" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>aria<wbr/>Label</span></a><a href="#cssclass" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>css<wbr/>Class</span></a><a href="#cssclasses" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>css<wbr/>Classes</span></a><a href="#cssprefix" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>css<wbr/>Prefix</span></a><a href="#disabled" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>disabled</span></a><a href="#for" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>for</span></a><a href="#hidden" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>hidden</span></a><a href="#hideinliveplayback"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>hide<wbr/>In<wbr/>Live<wbr/>Playback</span></a><a href="#id" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a><a href="#labelstyle" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>label<wbr/>Style</span></a><a href="#role" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>role</span></a><a href="#tabindex" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tab<wbr/>Index</span></a><a href="#tag" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tag</span></a><a href="#text" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>text</span></a><a href="#timelabelmode"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>time<wbr/>Label<wbr/>Mode</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">bitmovin-player-ui</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>PlaybackToggleButtonConfig | bitmovin-player-ui</title><meta name="description" content="Documentation for bitmovin-player-ui"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">bitmovin-player-ui</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">PlaybackToggleButtonConfig</a></li></ul><h1>Interface PlaybackToggleButtonConfig</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">PlaybackToggleButtonConfig</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#acceptstouchwithuihidden">acceptsTouchWithUiHidden</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#arialabel">ariaLabel</a><span class="tsd-signature-symbol">?:</span> <a href="../types/LocalizableText.html" class="tsd-signature-type tsd-kind-type-alias">LocalizableText</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#buttonstyle">buttonStyle</a><span class="tsd-signature-symbol">?:</span> <a href="../enums/ButtonStyle.html" class="tsd-signature-type tsd-kind-enum">ButtonStyle</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#cssclass">cssClass</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#cssclasses">cssClasses</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#cssprefix">cssPrefix</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#disabled">disabled</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#enterfullscreenoninitialplayback">enterFullscreenOnInitialPlayback</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#hidden">hidden</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#id">id</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#offarialabel">offAriaLabel</a><span class="tsd-signature-symbol">?:</span> <a href="../types/LocalizableText.html" class="tsd-signature-type tsd-kind-type-alias">LocalizableText</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#offclass">offClass</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#onarialabel">onAriaLabel</a><span class="tsd-signature-symbol">?:</span> <a href="../types/LocalizableText.html" class="tsd-signature-type tsd-kind-type-alias">LocalizableText</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#onclass">onClass</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#role">role</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#tabindex">tabIndex</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#tag">tag</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#text">text</a><span class="tsd-signature-symbol">?:</span> <a href="../types/LocalizableText.html" class="tsd-signature-type tsd-kind-type-alias">LocalizableText</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy" data-refl="
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>PlaybackToggleButtonConfig | bitmovin-player-ui</title><meta name="description" content="Documentation for bitmovin-player-ui"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">bitmovin-player-ui</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">PlaybackToggleButtonConfig</a></li></ul><h1>Interface PlaybackToggleButtonConfig</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">PlaybackToggleButtonConfig</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#acceptstouchwithuihidden">acceptsTouchWithUiHidden</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#arialabel">ariaLabel</a><span class="tsd-signature-symbol">?:</span> <a href="../types/LocalizableText.html" class="tsd-signature-type tsd-kind-type-alias">LocalizableText</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#buttonstyle">buttonStyle</a><span class="tsd-signature-symbol">?:</span> <a href="../enums/ButtonStyle.html" class="tsd-signature-type tsd-kind-enum">ButtonStyle</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#cssclass">cssClass</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#cssclasses">cssClasses</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#cssprefix">cssPrefix</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#disabled">disabled</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#enterfullscreenoninitialplayback">enterFullscreenOnInitialPlayback</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#hidden">hidden</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#id">id</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#offarialabel">offAriaLabel</a><span class="tsd-signature-symbol">?:</span> <a href="../types/LocalizableText.html" class="tsd-signature-type tsd-kind-type-alias">LocalizableText</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#offclass">offClass</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#onarialabel">onAriaLabel</a><span class="tsd-signature-symbol">?:</span> <a href="../types/LocalizableText.html" class="tsd-signature-type tsd-kind-type-alias">LocalizableText</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#onclass">onClass</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#role">role</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#tabindex">tabIndex</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#tag">tag</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#text">text</a><span class="tsd-signature-symbol">?:</span> <a href="../types/LocalizableText.html" class="tsd-signature-type tsd-kind-type-alias">LocalizableText</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy" data-refl="1657"><h4>Hierarchy (<a href="../hierarchy.html#PlaybackToggleButtonConfig">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="ToggleButtonConfig.html" class="tsd-signature-type tsd-kind-interface">ToggleButtonConfig</a><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">PlaybackToggleButtonConfig</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/buttons/PlaybackToggleButton.ts#L10">src/ts/components/buttons/PlaybackToggleButton.ts:10</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#acceptstouchwithuihidden" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>accepts<wbr/>Touch<wbr/>With<wbr/>Ui<wbr/>Hidden?</span></a>
|
|
2
2
|
<a href="#arialabel" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>aria<wbr/>Label?</span></a>
|
|
3
3
|
<a href="#buttonstyle" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>button<wbr/>Style?</span></a>
|
|
4
4
|
<a href="#cssclass" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>css<wbr/>Class?</span></a>
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
<a href="#text" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>text?</span></a>
|
|
19
19
|
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="acceptstouchwithuihidden"><code class="tsd-tag">Optional</code><span>accepts<wbr/>Touch<wbr/>With<wbr/>Ui<wbr/>Hidden</span><a href="#acceptstouchwithuihidden" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">acceptsTouchWithUiHidden</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Specifies whether the first touch event received by the <a href="../classes/UIContainer.html" class="tsd-kind-class">UIContainer</a> should be prevented or not.</p>
|
|
20
20
|
<p>Default: false</p>
|
|
21
|
-
</div><aside class="tsd-sources"><p>Inherited from <a href="ToggleButtonConfig.html">ToggleButtonConfig</a>.<a href="ToggleButtonConfig.html#acceptstouchwithuihidden">acceptsTouchWithUiHidden</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
21
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="ToggleButtonConfig.html">ToggleButtonConfig</a>.<a href="ToggleButtonConfig.html#acceptstouchwithuihidden">acceptsTouchWithUiHidden</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/buttons/Button.ts#L51">src/ts/components/buttons/Button.ts:51</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="arialabel"><code class="tsd-tag">Optional</code><span>aria<wbr/>Label</span><a href="#arialabel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ariaLabel</span><span class="tsd-signature-symbol">?:</span> <a href="../types/LocalizableText.html" class="tsd-signature-type tsd-kind-type-alias">LocalizableText</a></div><div class="tsd-comment tsd-typography"><p>WCAG20 standard for defining info about the component (usually the name)</p>
|
|
22
22
|
<p>It is recommended to use <code>onAriaLabel</code> and <code>offAriaLabel</code> for toggle buttons
|
|
23
23
|
as the component can then update them as the button is used. If this is the case,
|
|
24
24
|
the <code>aria-pressed</code> attribute is not set as the specification defines either the name
|
|
@@ -26,27 +26,27 @@ or the pressed-state should be changed, but not both.
|
|
|
26
26
|
Some platforms, like many versions of Samsung Tizen TVs, don't support the <code>aria-pressed</code>
|
|
27
27
|
attribute, so it is recommended to use <code>onAriaLabel</code> and <code>offAriaLabel</code> instead.</p>
|
|
28
28
|
<p>If both <code>ariaLabel</code> and <code>onAriaLabel</code> are set, <code>onAriaLabel</code> is used.</p>
|
|
29
|
-
</div><aside class="tsd-sources"><p>Inherited from <a href="ToggleButtonConfig.html">ToggleButtonConfig</a>.<a href="ToggleButtonConfig.html#arialabel">ariaLabel</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
29
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="ToggleButtonConfig.html">ToggleButtonConfig</a>.<a href="ToggleButtonConfig.html#arialabel">ariaLabel</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/buttons/ToggleButton.ts#L33">src/ts/components/buttons/ToggleButton.ts:33</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="buttonstyle"><code class="tsd-tag">Optional</code><span>button<wbr/>Style</span><a href="#buttonstyle" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">buttonStyle</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/ButtonStyle.html" class="tsd-signature-type tsd-kind-enum">ButtonStyle</a></div><div class="tsd-comment tsd-typography"><p>The style of the button.
|
|
30
30
|
Default: <a href="../enums/ButtonStyle.html#icon" class="tsd-kind-enum-member">ButtonStyle.Icon</a></p>
|
|
31
|
-
</div><aside class="tsd-sources"><p>Inherited from <a href="ToggleButtonConfig.html">ToggleButtonConfig</a>.<a href="ToggleButtonConfig.html#buttonstyle">buttonStyle</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
32
|
-
</div><aside class="tsd-sources"><p>Inherited from <a href="ToggleButtonConfig.html">ToggleButtonConfig</a>.<a href="ToggleButtonConfig.html#cssclass">cssClass</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
33
|
-
</div><aside class="tsd-sources"><p>Inherited from <a href="ToggleButtonConfig.html">ToggleButtonConfig</a>.<a href="ToggleButtonConfig.html#cssclasses">cssClasses</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
34
|
-
</div><aside class="tsd-sources"><p>Inherited from <a href="ToggleButtonConfig.html">ToggleButtonConfig</a>.<a href="ToggleButtonConfig.html#cssprefix">cssPrefix</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
31
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="ToggleButtonConfig.html">ToggleButtonConfig</a>.<a href="ToggleButtonConfig.html#buttonstyle">buttonStyle</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/buttons/Button.ts#L57">src/ts/components/buttons/Button.ts:57</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="cssclass"><code class="tsd-tag">Optional</code><span>css<wbr/>Class</span><a href="#cssclass" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cssClass</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The CSS classes of the component. This is usually the class from where the component takes its styling.</p>
|
|
32
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="ToggleButtonConfig.html">ToggleButtonConfig</a>.<a href="ToggleButtonConfig.html#cssclass">cssClass</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/Component.ts#L34">src/ts/components/Component.ts:34</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="cssclasses"><code class="tsd-tag">Optional</code><span>css<wbr/>Classes</span><a href="#cssclasses" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cssClasses</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Additional CSS classes of the component.</p>
|
|
33
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="ToggleButtonConfig.html">ToggleButtonConfig</a>.<a href="ToggleButtonConfig.html#cssclasses">cssClasses</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/Component.ts#L39">src/ts/components/Component.ts:39</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="cssprefix"><code class="tsd-tag">Optional</code><span>css<wbr/>Prefix</span><a href="#cssprefix" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cssPrefix</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>A prefix to prepend all CSS classes with.</p>
|
|
34
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="ToggleButtonConfig.html">ToggleButtonConfig</a>.<a href="ToggleButtonConfig.html#cssprefix">cssPrefix</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/Component.ts#L29">src/ts/components/Component.ts:29</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="disabled"><code class="tsd-tag">Optional</code><span>disabled</span><a href="#disabled" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">disabled</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Specifies if the component is enabled (interactive) or not.
|
|
35
35
|
Default: false</p>
|
|
36
|
-
</div><aside class="tsd-sources"><p>Inherited from <a href="ToggleButtonConfig.html">ToggleButtonConfig</a>.<a href="ToggleButtonConfig.html#disabled">disabled</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
36
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="ToggleButtonConfig.html">ToggleButtonConfig</a>.<a href="ToggleButtonConfig.html#disabled">disabled</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/Component.ts#L51">src/ts/components/Component.ts:51</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="enterfullscreenoninitialplayback"><code class="tsd-tag">Optional</code><span>enter<wbr/>Fullscreen<wbr/>On<wbr/>Initial<wbr/>Playback</span><a href="#enterfullscreenoninitialplayback" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">enterFullscreenOnInitialPlayback</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Specify whether the player should be set to enter fullscreen by clicking on the playback toggle button
|
|
37
37
|
when initiating the initial playback.
|
|
38
38
|
Default is false.</p>
|
|
39
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
39
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/buttons/PlaybackToggleButton.ts#L16">src/ts/components/buttons/PlaybackToggleButton.ts:16</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="hidden"><code class="tsd-tag">Optional</code><span>hidden</span><a href="#hidden" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">hidden</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Specifies if the component should be hidden at startup.
|
|
40
40
|
Default: false</p>
|
|
41
|
-
</div><aside class="tsd-sources"><p>Inherited from <a href="ToggleButtonConfig.html">ToggleButtonConfig</a>.<a href="ToggleButtonConfig.html#hidden">hidden</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
41
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="ToggleButtonConfig.html">ToggleButtonConfig</a>.<a href="ToggleButtonConfig.html#hidden">hidden</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/Component.ts#L45">src/ts/components/Component.ts:45</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="id"><code class="tsd-tag">Optional</code><span>id</span><a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The HTML ID of the component.
|
|
42
42
|
Default: automatically generated with pattern 'ui-id-{guid}'.</p>
|
|
43
|
-
</div><aside class="tsd-sources"><p>Inherited from <a href="ToggleButtonConfig.html">ToggleButtonConfig</a>.<a href="ToggleButtonConfig.html#id">id</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
44
|
-
</div><aside class="tsd-sources"><p>Inherited from <a href="ToggleButtonConfig.html">ToggleButtonConfig</a>.<a href="ToggleButtonConfig.html#offarialabel">offAriaLabel</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
45
|
-
</div><aside class="tsd-sources"><p>Inherited from <a href="ToggleButtonConfig.html">ToggleButtonConfig</a>.<a href="ToggleButtonConfig.html#offclass">offClass</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
46
|
-
</div><aside class="tsd-sources"><p>Inherited from <a href="ToggleButtonConfig.html">ToggleButtonConfig</a>.<a href="ToggleButtonConfig.html#onarialabel">onAriaLabel</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
47
|
-
</div><aside class="tsd-sources"><p>Inherited from <a href="ToggleButtonConfig.html">ToggleButtonConfig</a>.<a href="ToggleButtonConfig.html#onclass">onClass</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
48
|
-
</div><aside class="tsd-sources"><p>Inherited from <a href="ToggleButtonConfig.html">ToggleButtonConfig</a>.<a href="ToggleButtonConfig.html#role">role</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
49
|
-
</div><aside class="tsd-sources"><p>Inherited from <a href="ToggleButtonConfig.html">ToggleButtonConfig</a>.<a href="ToggleButtonConfig.html#tabindex">tabIndex</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
43
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="ToggleButtonConfig.html">ToggleButtonConfig</a>.<a href="ToggleButtonConfig.html#id">id</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/Component.ts#L24">src/ts/components/Component.ts:24</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="offarialabel"><code class="tsd-tag">Optional</code><span>off<wbr/>Aria<wbr/>Label</span><a href="#offarialabel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">offAriaLabel</span><span class="tsd-signature-symbol">?:</span> <a href="../types/LocalizableText.html" class="tsd-signature-type tsd-kind-type-alias">LocalizableText</a></div><div class="tsd-comment tsd-typography"><p>The aria label that marks the off-state of the button.</p>
|
|
44
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="ToggleButtonConfig.html">ToggleButtonConfig</a>.<a href="ToggleButtonConfig.html#offarialabel">offAriaLabel</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/buttons/ToggleButton.ts#L41">src/ts/components/buttons/ToggleButton.ts:41</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="offclass"><code class="tsd-tag">Optional</code><span>off<wbr/>Class</span><a href="#offclass" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">offClass</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The CSS class that marks the off-state of the button.</p>
|
|
45
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="ToggleButtonConfig.html">ToggleButtonConfig</a>.<a href="ToggleButtonConfig.html#offclass">offClass</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/buttons/ToggleButton.ts#L20">src/ts/components/buttons/ToggleButton.ts:20</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="onarialabel"><code class="tsd-tag">Optional</code><span>on<wbr/>Aria<wbr/>Label</span><a href="#onarialabel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">onAriaLabel</span><span class="tsd-signature-symbol">?:</span> <a href="../types/LocalizableText.html" class="tsd-signature-type tsd-kind-type-alias">LocalizableText</a></div><div class="tsd-comment tsd-typography"><p>The aria label that marks the on-state of the button.</p>
|
|
46
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="ToggleButtonConfig.html">ToggleButtonConfig</a>.<a href="ToggleButtonConfig.html#onarialabel">onAriaLabel</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/buttons/ToggleButton.ts#L37">src/ts/components/buttons/ToggleButton.ts:37</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="onclass"><code class="tsd-tag">Optional</code><span>on<wbr/>Class</span><a href="#onclass" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">onClass</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The CSS class that marks the on-state of the button.</p>
|
|
47
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="ToggleButtonConfig.html">ToggleButtonConfig</a>.<a href="ToggleButtonConfig.html#onclass">onClass</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/buttons/ToggleButton.ts#L16">src/ts/components/buttons/ToggleButton.ts:16</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="role"><code class="tsd-tag">Optional</code><span>role</span><a href="#role" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">role</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Specifies the component role for WCAG20 standard</p>
|
|
48
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="ToggleButtonConfig.html">ToggleButtonConfig</a>.<a href="ToggleButtonConfig.html#role">role</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/Component.ts#L56">src/ts/components/Component.ts:56</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="tabindex"><code class="tsd-tag">Optional</code><span>tab<wbr/>Index</span><a href="#tabindex" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">tabIndex</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>WCAG20 requirement for screen reader navigation</p>
|
|
49
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="ToggleButtonConfig.html">ToggleButtonConfig</a>.<a href="ToggleButtonConfig.html#tabindex">tabIndex</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/Component.ts#L61">src/ts/components/Component.ts:61</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="tag"><code class="tsd-tag">Optional</code><span>tag</span><a href="#tag" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">tag</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The HTML tag name of the component.
|
|
50
50
|
Default: 'div'</p>
|
|
51
|
-
</div><aside class="tsd-sources"><p>Inherited from <a href="ToggleButtonConfig.html">ToggleButtonConfig</a>.<a href="ToggleButtonConfig.html#tag">tag</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
52
|
-
</div><aside class="tsd-sources"><p>Inherited from <a href="ToggleButtonConfig.html">ToggleButtonConfig</a>.<a href="ToggleButtonConfig.html#text">text</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
51
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="ToggleButtonConfig.html">ToggleButtonConfig</a>.<a href="ToggleButtonConfig.html#tag">tag</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/Component.ts#L19">src/ts/components/Component.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="text"><code class="tsd-tag">Optional</code><span>text</span><a href="#text" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">text</span><span class="tsd-signature-symbol">?:</span> <a href="../types/LocalizableText.html" class="tsd-signature-type tsd-kind-type-alias">LocalizableText</a></div><div class="tsd-comment tsd-typography"><p>The text as string or as localize callback on the button.</p>
|
|
52
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="ToggleButtonConfig.html">ToggleButtonConfig</a>.<a href="ToggleButtonConfig.html#text">text</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/buttons/ToggleButton.ts#L45">src/ts/components/buttons/ToggleButton.ts:45</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#acceptstouchwithuihidden" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>accepts<wbr/>Touch<wbr/>With<wbr/>Ui<wbr/>Hidden</span></a><a href="#arialabel" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>aria<wbr/>Label</span></a><a href="#buttonstyle" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>button<wbr/>Style</span></a><a href="#cssclass" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>css<wbr/>Class</span></a><a href="#cssclasses" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>css<wbr/>Classes</span></a><a href="#cssprefix" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>css<wbr/>Prefix</span></a><a href="#disabled" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>disabled</span></a><a href="#enterfullscreenoninitialplayback"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>enter<wbr/>Fullscreen<wbr/>On<wbr/>Initial<wbr/>Playback</span></a><a href="#hidden" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>hidden</span></a><a href="#id" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a><a href="#offarialabel" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>off<wbr/>Aria<wbr/>Label</span></a><a href="#offclass" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>off<wbr/>Class</span></a><a href="#onarialabel" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Aria<wbr/>Label</span></a><a href="#onclass" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Class</span></a><a href="#role" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>role</span></a><a href="#tabindex" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tab<wbr/>Index</span></a><a href="#tag" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tag</span></a><a href="#text" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>text</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">bitmovin-player-ui</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|