bitmovin-player-ui
    Preparing search index...

    Interface UIComponentLayoutOverrides

    Component layout overrides keyed by public component class name, optionally scoped by UI variant.

    Overrides are applied after a UI variant has been resolved and before configureControls() runs. Excluded components are removed from the resolved component tree and released before the remaining components are initialized or configured.

    UI variants created by the built-in UIFactory.build*UI() functions have a UIVariantIdentifier. Custom UIManager variants must provide an identifier to participate in component layout overrides; variants without one keep their resolved component tree unchanged.

    Only component types exposed by UIComponentLayoutOverrideMap and addressable in the resolved default layout are supported. Custom components, nested components managed outside the container tree, and components created at runtime cannot be overridden. Setting components owned by a SettingsPanelItem are supported by removing the owning settings row when excluded.

    Precedence is resolved in this order:

    1. Built-in default layout membership
    2. Legacy aliases (includeWatermark, ecoMode, and playbackSpeedSelectionEnabled)
    3. Top-level componentLayoutOverrides
    4. Variant-scoped componentLayoutOverrides

    Top-level entries apply to all identified UI variants. Variant-scoped entries override top-level entries for the matching variant.

    Base component keys also apply to subclasses, and more specific component keys override base component keys. For example, ToggleButton applies to FullscreenToggleButton, unless FullscreenToggleButton has its own override.

    Default component layout overrides for identified variants:

    componentLayoutOverrides: {
      CaptionToggleButton: UIComponentLayoutOverride.Exclude,
      EcoModeContainer: UIComponentLayoutOverride.Exclude,
      QuickSeekButton: UIComponentLayoutOverride.Exclude,
      Watermark: UIComponentLayoutOverride.Exclude,
    }

    componentLayoutOverrides: {
      FullscreenToggleButton: UIComponentLayoutOverride.Exclude,

      [UIVariantIdentifier.main]: {
        FullscreenToggleButton: UIComponentLayoutOverride.Include,
        Watermark: UIComponentLayoutOverride.Include,
      },
    }
    interface UIComponentLayoutOverrides {
        AdClickOverlay?: UIComponentLayoutOverride;
        AdControlBar?: UIComponentLayoutOverride;
        AdCounterLabel?: UIComponentLayoutOverride;
        AdMessageLabel?: UIComponentLayoutOverride;
        ads?: UIComponentLayoutOverrideMap;
        AdSkipButton?: UIComponentLayoutOverride;
        AdStatusOverlay?: UIComponentLayoutOverride;
        AirPlayToggleButton?: UIComponentLayoutOverride;
        AudioQualitySelectBox?: UIComponentLayoutOverride;
        AudioTrackListBox?: UIComponentLayoutOverride;
        AudioTrackSelectBox?: UIComponentLayoutOverride;
        BackgroundColorSelectBox?: UIComponentLayoutOverride;
        BackgroundOpacitySelectBox?: UIComponentLayoutOverride;
        BufferingOverlay?: UIComponentLayoutOverride;
        Button?: UIComponentLayoutOverride;
        CaptionToggleButton?: UIComponentLayoutOverride;
        castReceiver?: UIComponentLayoutOverrideMap;
        CastStatusOverlay?: UIComponentLayoutOverride;
        CastToggleButton?: UIComponentLayoutOverride;
        CharacterEdgeColorSelectBox?: UIComponentLayoutOverride;
        CharacterEdgeSelectBox?: UIComponentLayoutOverride;
        ClickOverlay?: UIComponentLayoutOverride;
        Component?: UIComponentLayoutOverride;
        Container?: UIComponentLayoutOverride;
        ContextMenu?: UIComponentLayoutOverride;
        ControlBar?: UIComponentLayoutOverride;
        DismissClickOverlay?: UIComponentLayoutOverride;
        DynamicSettingsPanelItem?: UIComponentLayoutOverride;
        EcoModeContainer?: UIComponentLayoutOverride;
        EcoModeToggleButton?: UIComponentLayoutOverride;
        empty?: UIComponentLayoutOverrideMap;
        ErrorMessageOverlay?: UIComponentLayoutOverride;
        FontColorSelectBox?: UIComponentLayoutOverride;
        FontFamilySelectBox?: UIComponentLayoutOverride;
        FontOpacitySelectBox?: UIComponentLayoutOverride;
        FontSizeSelectBox?: UIComponentLayoutOverride;
        FontStyleSelectBox?: UIComponentLayoutOverride;
        FullscreenToggleButton?: UIComponentLayoutOverride;
        HugePlaybackToggleButton?: UIComponentLayoutOverride;
        HugeReplayButton?: UIComponentLayoutOverride;
        InteractiveContextMenuItem?: UIComponentLayoutOverride;
        InteractiveSettingsPanelItem?: UIComponentLayoutOverride;
        Label?: UIComponentLayoutOverride;
        ListBox?: UIComponentLayoutOverride;
        ListSelector?: UIComponentLayoutOverride;
        main?: UIComponentLayoutOverrideMap;
        MetadataLabel?: UIComponentLayoutOverride;
        PersistentPreferencesToggleButton?: UIComponentLayoutOverride;
        PictureInPictureToggleButton?: UIComponentLayoutOverride;
        PlaybackSpeedSelectBox?: UIComponentLayoutOverride;
        PlaybackTimeLabel?: UIComponentLayoutOverride;
        PlaybackToggleButton?: UIComponentLayoutOverride;
        PlaybackToggleOverlay?: UIComponentLayoutOverride;
        PlayerContextMenu?: UIComponentLayoutOverride;
        PlayerInsightsPanel?: UIComponentLayoutOverride;
        QuickSeekButton?: UIComponentLayoutOverride;
        RecommendationOverlay?: UIComponentLayoutOverride;
        SeekBar?: UIComponentLayoutOverride;
        SelectBox?: UIComponentLayoutOverride;
        SettingsPanel?: UIComponentLayoutOverride;
        SettingsPanelItem?: UIComponentLayoutOverride;
        SettingsPanelPage?: UIComponentLayoutOverride;
        SettingsPanelPageBackButton?: UIComponentLayoutOverride;
        SettingsPanelPageNavigatorButton?: UIComponentLayoutOverride;
        SettingsPanelSeparator?: UIComponentLayoutOverride;
        SettingsToggleButton?: UIComponentLayoutOverride;
        SmallCenteredPlaybackToggleButton?: UIComponentLayoutOverride;
        smallScreen?: UIComponentLayoutOverrideMap;
        smallScreenAds?: UIComponentLayoutOverrideMap;
        Spacer?: UIComponentLayoutOverride;
        subtitle?: UIComponentLayoutOverrideMap;
        SubtitleListBox?: UIComponentLayoutOverride;
        SubtitleOverlay?: UIComponentLayoutOverride;
        SubtitleSelectBox?: UIComponentLayoutOverride;
        SubtitleSettingSelectBox?: UIComponentLayoutOverride;
        SubtitleSettingsPanelPage?: UIComponentLayoutOverride;
        SubtitleSettingsResetButton?: UIComponentLayoutOverride;
        TitleBar?: UIComponentLayoutOverride;
        ToggleButton?: UIComponentLayoutOverride;
        ToggleSettingsPanelItem?: UIComponentLayoutOverride;
        TouchControlOverlay?: UIComponentLayoutOverride;
        tv?: UIComponentLayoutOverrideMap;
        tvAds?: UIComponentLayoutOverrideMap;
        TvNoiseCanvas?: UIComponentLayoutOverride;
        VideoQualitySelectBox?: UIComponentLayoutOverride;
        VolumeSlider?: UIComponentLayoutOverride;
        VolumeToggleButton?: UIComponentLayoutOverride;
        VRToggleButton?: UIComponentLayoutOverride;
        Watermark?: UIComponentLayoutOverride;
        WindowColorSelectBox?: UIComponentLayoutOverride;
        WindowOpacitySelectBox?: UIComponentLayoutOverride;
    }

    Hierarchy (View Summary)

    Index

    UI variants

    ads? castReceiver? empty? main? smallScreen? smallScreenAds? subtitle? tv? tvAds?

    Components

    AdClickOverlay? AdControlBar? AdCounterLabel? AdMessageLabel? AdSkipButton? AdStatusOverlay? AirPlayToggleButton? AudioQualitySelectBox? AudioTrackListBox? AudioTrackSelectBox? BackgroundColorSelectBox? BackgroundOpacitySelectBox? BufferingOverlay? Button? CaptionToggleButton? CastStatusOverlay? CastToggleButton? CharacterEdgeColorSelectBox? CharacterEdgeSelectBox? ClickOverlay? Component? Container? ContextMenu? ControlBar? DismissClickOverlay? DynamicSettingsPanelItem? EcoModeContainer? EcoModeToggleButton? ErrorMessageOverlay? FontColorSelectBox? FontFamilySelectBox? FontOpacitySelectBox? FontSizeSelectBox? FontStyleSelectBox? FullscreenToggleButton? HugePlaybackToggleButton? HugeReplayButton? InteractiveContextMenuItem? InteractiveSettingsPanelItem? Label? ListBox? ListSelector? MetadataLabel? PersistentPreferencesToggleButton? PictureInPictureToggleButton? PlaybackSpeedSelectBox? PlaybackTimeLabel? PlaybackToggleButton? PlaybackToggleOverlay? PlayerContextMenu? PlayerInsightsPanel? QuickSeekButton? RecommendationOverlay? SeekBar? SelectBox? SettingsPanel? SettingsPanelItem? SettingsPanelPage? SettingsPanelPageBackButton? SettingsPanelPageNavigatorButton? SettingsPanelSeparator? SettingsToggleButton? SmallCenteredPlaybackToggleButton? Spacer? SubtitleListBox? SubtitleOverlay? SubtitleSelectBox? SubtitleSettingSelectBox? SubtitleSettingsPanelPage? SubtitleSettingsResetButton? TitleBar? ToggleButton? ToggleSettingsPanelItem? TouchControlOverlay? TvNoiseCanvas? VideoQualitySelectBox? VolumeSlider? VolumeToggleButton? VRToggleButton? Watermark? WindowColorSelectBox? WindowOpacitySelectBox?

    UI variants

    ads?: UIComponentLayoutOverrideMap

    Component layout overrides for the ads UI variant.

    castReceiver?: UIComponentLayoutOverrideMap

    Component layout overrides for the castReceiver UI variant.

    empty?: UIComponentLayoutOverrideMap

    Component layout overrides for the empty UI variant.

    main?: UIComponentLayoutOverrideMap

    Component layout overrides for the main UI variant.

    smallScreen?: UIComponentLayoutOverrideMap

    Component layout overrides for the small-screen UI variant.

    smallScreenAds?: UIComponentLayoutOverrideMap

    Component layout overrides for the small-screen ads UI variant.

    subtitle?: UIComponentLayoutOverrideMap

    Component layout overrides for the subtitle UI variant.

    tv?: UIComponentLayoutOverrideMap

    Component layout overrides for the TV UI variant.

    tvAds?: UIComponentLayoutOverrideMap

    Component layout overrides for the TV ads UI variant.

    Components

    AdClickOverlay?: UIComponentLayoutOverride
    AdControlBar?: UIComponentLayoutOverride
    AdCounterLabel?: UIComponentLayoutOverride
    AdMessageLabel?: UIComponentLayoutOverride
    AdSkipButton?: UIComponentLayoutOverride
    AdStatusOverlay?: UIComponentLayoutOverride
    AirPlayToggleButton?: UIComponentLayoutOverride
    AudioQualitySelectBox?: UIComponentLayoutOverride
    AudioTrackListBox?: UIComponentLayoutOverride
    AudioTrackSelectBox?: UIComponentLayoutOverride
    BackgroundColorSelectBox?: UIComponentLayoutOverride
    BackgroundOpacitySelectBox?: UIComponentLayoutOverride
    BufferingOverlay?: UIComponentLayoutOverride
    Button?: UIComponentLayoutOverride
    CaptionToggleButton?: UIComponentLayoutOverride
    CastStatusOverlay?: UIComponentLayoutOverride
    CastToggleButton?: UIComponentLayoutOverride
    CharacterEdgeColorSelectBox?: UIComponentLayoutOverride
    CharacterEdgeSelectBox?: UIComponentLayoutOverride
    ClickOverlay?: UIComponentLayoutOverride
    Component?: UIComponentLayoutOverride
    Container?: UIComponentLayoutOverride
    ContextMenu?: UIComponentLayoutOverride
    ControlBar?: UIComponentLayoutOverride
    DismissClickOverlay?: UIComponentLayoutOverride
    DynamicSettingsPanelItem?: UIComponentLayoutOverride
    EcoModeContainer?: UIComponentLayoutOverride
    EcoModeToggleButton?: UIComponentLayoutOverride
    ErrorMessageOverlay?: UIComponentLayoutOverride
    FontColorSelectBox?: UIComponentLayoutOverride
    FontFamilySelectBox?: UIComponentLayoutOverride
    FontOpacitySelectBox?: UIComponentLayoutOverride
    FontSizeSelectBox?: UIComponentLayoutOverride
    FontStyleSelectBox?: UIComponentLayoutOverride
    FullscreenToggleButton?: UIComponentLayoutOverride
    HugePlaybackToggleButton?: UIComponentLayoutOverride
    HugeReplayButton?: UIComponentLayoutOverride
    InteractiveContextMenuItem?: UIComponentLayoutOverride
    InteractiveSettingsPanelItem?: UIComponentLayoutOverride
    Label?: UIComponentLayoutOverride
    ListBox?: UIComponentLayoutOverride
    ListSelector?: UIComponentLayoutOverride
    MetadataLabel?: UIComponentLayoutOverride
    PersistentPreferencesToggleButton?: UIComponentLayoutOverride
    PictureInPictureToggleButton?: UIComponentLayoutOverride
    PlaybackSpeedSelectBox?: UIComponentLayoutOverride
    PlaybackTimeLabel?: UIComponentLayoutOverride
    PlaybackToggleButton?: UIComponentLayoutOverride
    PlaybackToggleOverlay?: UIComponentLayoutOverride
    PlayerContextMenu?: UIComponentLayoutOverride
    PlayerInsightsPanel?: UIComponentLayoutOverride
    QuickSeekButton?: UIComponentLayoutOverride
    RecommendationOverlay?: UIComponentLayoutOverride
    SeekBar?: UIComponentLayoutOverride
    SelectBox?: UIComponentLayoutOverride
    SettingsPanel?: UIComponentLayoutOverride
    SettingsPanelItem?: UIComponentLayoutOverride
    SettingsPanelPage?: UIComponentLayoutOverride
    SettingsPanelPageBackButton?: UIComponentLayoutOverride
    SettingsPanelPageNavigatorButton?: UIComponentLayoutOverride
    SettingsPanelSeparator?: UIComponentLayoutOverride
    SettingsToggleButton?: UIComponentLayoutOverride
    SmallCenteredPlaybackToggleButton?: UIComponentLayoutOverride
    Spacer?: UIComponentLayoutOverride
    SubtitleListBox?: UIComponentLayoutOverride
    SubtitleOverlay?: UIComponentLayoutOverride
    SubtitleSelectBox?: UIComponentLayoutOverride
    SubtitleSettingSelectBox?: UIComponentLayoutOverride
    SubtitleSettingsPanelPage?: UIComponentLayoutOverride
    SubtitleSettingsResetButton?: UIComponentLayoutOverride
    TitleBar?: UIComponentLayoutOverride
    ToggleButton?: UIComponentLayoutOverride
    ToggleSettingsPanelItem?: UIComponentLayoutOverride
    TouchControlOverlay?: UIComponentLayoutOverride
    TvNoiseCanvas?: UIComponentLayoutOverride
    VideoQualitySelectBox?: UIComponentLayoutOverride
    VolumeSlider?: UIComponentLayoutOverride
    VolumeToggleButton?: UIComponentLayoutOverride
    VRToggleButton?: UIComponentLayoutOverride
    Watermark?: UIComponentLayoutOverride
    WindowColorSelectBox?: UIComponentLayoutOverride
    WindowOpacitySelectBox?: UIComponentLayoutOverride

    Settings

    Member Visibility

    On This Page

    UI variants
    Components
    AdClickOverlayAdControlBarAdCounterLabelAdMessageLabelAdSkipButtonAdStatusOverlayAirPlayToggleButtonAudioQualitySelectBoxAudioTrackListBoxAudioTrackSelectBoxBackgroundColorSelectBoxBackgroundOpacitySelectBoxBufferingOverlayButtonCaptionToggleButtonCastStatusOverlayCastToggleButtonCharacterEdgeColorSelectBoxCharacterEdgeSelectBoxClickOverlayComponentContainerContextMenuControlBarDismissClickOverlayDynamicSettingsPanelItemEcoModeContainerEcoModeToggleButtonErrorMessageOverlayFontColorSelectBoxFontFamilySelectBoxFontOpacitySelectBoxFontSizeSelectBoxFontStyleSelectBoxFullscreenToggleButtonHugePlaybackToggleButtonHugeReplayButtonInteractiveContextMenuItemInteractiveSettingsPanelItemLabelListBoxListSelectorMetadataLabelPersistentPreferencesToggleButtonPictureInPictureToggleButtonPlaybackSpeedSelectBoxPlaybackTimeLabelPlaybackToggleButtonPlaybackToggleOverlayPlayerContextMenuPlayerInsightsPanelQuickSeekButtonRecommendationOverlaySeekBarSelectBoxSettingsPanelSettingsPanelItemSettingsPanelPageSettingsPanelPageBackButtonSettingsPanelPageNavigatorButtonSettingsPanelSeparatorSettingsToggleButtonSmallCenteredPlaybackToggleButtonSpacerSubtitleListBoxSubtitleOverlaySubtitleSelectBoxSubtitleSettingSelectBoxSubtitleSettingsPanelPageSubtitleSettingsResetButtonTitleBarToggleButtonToggleSettingsPanelItemTouchControlOverlayTvNoiseCanvasVideoQualitySelectBoxVolumeSliderVolumeToggleButtonVRToggleButtonWatermarkWindowColorSelectBoxWindowOpacitySelectBox