bitmovin-player-ui
    Preparing search index...

    Interface UIComponentConfigOverrides

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

    Use UI variant keys to scope overrides to one layout. Use component class names to configure all instances of a component. Base component keys also apply to subclasses, and more specific component keys override base component config.

    Config precedence, from lowest to highest:

    1. Component superclass config
    2. Component default config
    3. Constructor config from the UIFactory
    4. Top-level base component config, e.g. ToggleButton
    5. Top-level specific component config, e.g. FullscreenToggleButton
    6. Variant-specific base component config, e.g. main.ToggleButton
    7. Variant-specific component config, e.g. main.FullscreenToggleButton
    const componentConfigOverrides: UIComponentConfigOverrides = {
      // Scoped by UI variants
      main: {
        // Any component class name can be used here.
        FullscreenToggleButton: {
          // Component specific config
        },
      },
      smallScreen: {
        // Variant-specific config overrides top-level component config.
        SeekBar: {
          // Component specific config
        },
      },

      // Any component class name can also be configured globally.
      ToggleButton: {
        // Component specific config
      },
      SeekBar: {
        // Component specific config
      },
    };
    interface UIComponentConfigOverrides {
        AdClickOverlay?: Partial<ClickOverlayConfig>;
        AdControlBar?: Partial<AdControlBarConfig>;
        AdCounterLabel?: Partial<AdCounterLabelConfig>;
        AdMessageLabel?: Partial<LabelConfig>;
        ads?: UIComponentConfigMap;
        AdSkipButton?: Partial<AdSkipButtonConfig>;
        AdStatusOverlay?: Partial<ContainerConfig>;
        AirPlayToggleButton?: Partial<ToggleButtonConfig>;
        AudioQualitySelectBox?: Partial<ListSelectorConfig>;
        AudioTrackListBox?: Partial<AudioTrackListBoxConfig>;
        AudioTrackSelectBox?: Partial<ListSelectorConfig>;
        BackgroundColorSelectBox?: Partial<SubtitleSettingSelectBoxConfig>;
        BackgroundOpacitySelectBox?: Partial<SubtitleSettingSelectBoxConfig>;
        BufferingOverlay?: Partial<BufferingOverlayConfig>;
        Button?: Partial<ButtonConfig>;
        castReceiver?: UIComponentConfigMap;
        CastStatusOverlay?: Partial<ContainerConfig>;
        CastToggleButton?: Partial<ToggleButtonConfig>;
        CastUIContainer?: Partial<UIContainerConfig>;
        CharacterEdgeColorSelectBox?: Partial<SubtitleSettingSelectBoxConfig>;
        CharacterEdgeSelectBox?: Partial<SubtitleSettingSelectBoxConfig>;
        ClickOverlay?: Partial<ClickOverlayConfig>;
        CloseButton?: Partial<CloseButtonConfig>;
        Component?: Partial<ComponentConfig>;
        Container?: Partial<ContainerConfig>;
        ContextMenu?: Partial<ContextMenuConfig>;
        ControlBar?: Partial<ControlBarConfig>;
        DismissClickOverlay?: Partial<DismissClickOverlayConfig>;
        DynamicSettingsPanelItem?: Partial<DynamicSettingsPanelItemConfig>;
        EcoModeContainer?: Partial<ContainerConfig>;
        EcoModeToggleButton?: Partial<ToggleButtonConfig>;
        empty?: UIComponentConfigMap;
        ErrorMessageOverlay?: Partial<ErrorMessageOverlayConfig>;
        FontColorSelectBox?: Partial<SubtitleSettingSelectBoxConfig>;
        FontFamilySelectBox?: Partial<SubtitleSettingSelectBoxConfig>;
        FontOpacitySelectBox?: Partial<SubtitleSettingSelectBoxConfig>;
        FontSizeSelectBox?: Partial<SubtitleSettingSelectBoxConfig>;
        FontStyleSelectBox?: Partial<SubtitleSettingSelectBoxConfig>;
        FullscreenToggleButton?: Partial<ToggleButtonConfig>;
        HugePlaybackToggleButton?: Partial<PlaybackToggleButtonConfig>;
        HugeReplayButton?: Partial<ButtonConfig>;
        Icon?: Partial<ComponentConfig>;
        InteractiveContextMenuItem?: Partial<InteractiveContextMenuItemConfig>;
        InteractiveSettingsPanelItem?: Partial<SettingsPanelItemConfig>;
        ItemSelectionList?: Partial<ListSelectorConfig>;
        Label?: Partial<LabelConfig>;
        ListBox?: Partial<ListBoxConfig>;
        ListSelector?: Partial<ListSelectorConfig>;
        main?: UIComponentConfigMap;
        MetadataLabel?: Partial<MetadataLabelConfig>;
        PersistentPreferencesToggleButton?: Partial<ToggleButtonConfig>;
        PictureInPictureToggleButton?: Partial<ToggleButtonConfig>;
        PlaybackSpeedSelectBox?: Partial<ListSelectorConfig>;
        PlaybackTimeLabel?: Partial<PlaybackTimeLabelConfig>;
        PlaybackToggleButton?: Partial<PlaybackToggleButtonConfig>;
        PlaybackToggleOverlay?: Partial<PlaybackToggleOverlayConfig>;
        PlayerContextMenu?: Partial<PlayerContextMenuConfig>;
        PlayerInsightsPanel?: Partial<PlayerInsightsPanelConfig>;
        QuickSeekButton?: Partial<QuickSeekButtonConfig>;
        RecommendationItem?: Partial<RecommendationItemConfig>;
        RecommendationOverlay?: Partial<ContainerConfig>;
        ReplayButton?: Partial<ButtonConfig>;
        SeekBar?: Partial<SeekBarConfig>;
        SeekBarLabel?: Partial<SeekBarLabelConfig>;
        SelectBox?: Partial<ListSelectorConfig>;
        SettingsPanel?: Partial<SettingsPanelConfig>;
        SettingsPanelItem?: Partial<SettingsPanelItemConfig>;
        SettingsPanelPage?: Partial<SettingsPanelPageConfig>;
        SettingsPanelPageBackButton?: Partial<SettingsPanelPageNavigatorConfig>;
        SettingsPanelPageNavigatorButton?: Partial<
            SettingsPanelPageNavigatorConfig,
        >;
        SettingsPanelPageOpenButton?: Partial<SettingsPanelPageNavigatorConfig>;
        SettingsPanelSelectOption?: Partial<SettingsPanelSelectOptionConfig>;
        SettingsPanelSeparator?: Partial<SettingsPanelSeparatorConfig>;
        SettingsToggleButton?: Partial<SettingsToggleButtonConfig>;
        SmallCenteredPlaybackToggleButton?: Partial<PlaybackToggleButtonConfig>;
        smallScreen?: UIComponentConfigMap;
        smallScreenAds?: UIComponentConfigMap;
        Spacer?: Partial<ComponentConfig>;
        subtitle?: UIComponentConfigMap;
        SubtitleListBox?: Partial<SubtitleListBoxConfig>;
        SubtitleOverlay?: Partial<SubtitleOverlayConfig>;
        SubtitleSelectBox?: Partial<ListSelectorConfig>;
        SubtitleSettingSelectBox?: Partial<SubtitleSettingSelectBoxConfig>;
        SubtitleSettingsPanelPage?: Partial<SubtitleSettingsPanelPageConfig>;
        SubtitleSettingsResetButton?: Partial<ButtonConfig>;
        TitleBar?: Partial<TitleBarConfig>;
        ToggleButton?: Partial<ToggleButtonConfig>;
        ToggleSettingsPanelItem?: Partial<ToggleSettingsPanelItem>;
        TouchControlOverlay?: Partial<TouchControlOverlayConfig>;
        tv?: UIComponentConfigMap;
        tvAds?: UIComponentConfigMap;
        TvNoiseCanvas?: Partial<ComponentConfig>;
        UIContainer?: Partial<UIContainerConfig>;
        VideoQualitySelectBox?: Partial<ListSelectorConfig>;
        VolumeControlButton?: Partial<VolumeControlButtonConfig>;
        VolumeSlider?: Partial<VolumeSliderConfig>;
        VolumeToggleButton?: Partial<ToggleButtonConfig>;
        VRToggleButton?: Partial<ToggleButtonConfig>;
        Watermark?: Partial<WatermarkConfig>;
        WindowColorSelectBox?: Partial<SubtitleSettingSelectBoxConfig>;
        WindowOpacitySelectBox?: Partial<SubtitleSettingSelectBoxConfig>;
    }

    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? CastStatusOverlay? CastToggleButton? CastUIContainer? CharacterEdgeColorSelectBox? CharacterEdgeSelectBox? ClickOverlay? CloseButton? Component? Container? ContextMenu? ControlBar? DismissClickOverlay? DynamicSettingsPanelItem? EcoModeContainer? EcoModeToggleButton? ErrorMessageOverlay? FontColorSelectBox? FontFamilySelectBox? FontOpacitySelectBox? FontSizeSelectBox? FontStyleSelectBox? FullscreenToggleButton? HugePlaybackToggleButton? HugeReplayButton? Icon? InteractiveContextMenuItem? InteractiveSettingsPanelItem? ItemSelectionList? Label? ListBox? ListSelector? MetadataLabel? PersistentPreferencesToggleButton? PictureInPictureToggleButton? PlaybackSpeedSelectBox? PlaybackTimeLabel? PlaybackToggleButton? PlaybackToggleOverlay? PlayerContextMenu? PlayerInsightsPanel? QuickSeekButton? RecommendationItem? RecommendationOverlay? ReplayButton? SeekBar? SeekBarLabel? SelectBox? SettingsPanel? SettingsPanelItem? SettingsPanelPage? SettingsPanelPageBackButton? SettingsPanelPageNavigatorButton? SettingsPanelPageOpenButton? SettingsPanelSelectOption? SettingsPanelSeparator? SettingsToggleButton? SmallCenteredPlaybackToggleButton? Spacer? SubtitleListBox? SubtitleOverlay? SubtitleSelectBox? SubtitleSettingSelectBox? SubtitleSettingsPanelPage? SubtitleSettingsResetButton? TitleBar? ToggleButton? ToggleSettingsPanelItem? TouchControlOverlay? TvNoiseCanvas? UIContainer? VideoQualitySelectBox? VolumeControlButton? VolumeSlider? VolumeToggleButton? VRToggleButton? Watermark? WindowColorSelectBox? WindowOpacitySelectBox?

    UI variants

    ads?: UIComponentConfigMap

    Component config overrides for the ads UI variant.

    castReceiver?: UIComponentConfigMap

    Component config overrides for the castReceiver UI variant.

    empty?: UIComponentConfigMap

    Component config overrides for the empty UI variant.

    main?: UIComponentConfigMap

    Component config overrides for the main UI variant.

    smallScreen?: UIComponentConfigMap

    Component config overrides for the small-screen UI variant.

    smallScreenAds?: UIComponentConfigMap

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

    subtitle?: UIComponentConfigMap

    Component config overrides for the subtitle UI variant.

    tv?: UIComponentConfigMap

    Component config overrides for the TV UI variant.

    tvAds?: UIComponentConfigMap

    Component config overrides for the TV ads UI variant.

    Components

    AdClickOverlay?: Partial<ClickOverlayConfig>
    AdControlBar?: Partial<AdControlBarConfig>
    AdCounterLabel?: Partial<AdCounterLabelConfig>
    AdMessageLabel?: Partial<LabelConfig>
    AdSkipButton?: Partial<AdSkipButtonConfig>
    AdStatusOverlay?: Partial<ContainerConfig>
    AirPlayToggleButton?: Partial<ToggleButtonConfig>
    AudioQualitySelectBox?: Partial<ListSelectorConfig>
    AudioTrackListBox?: Partial<AudioTrackListBoxConfig>
    AudioTrackSelectBox?: Partial<ListSelectorConfig>
    BackgroundColorSelectBox?: Partial<SubtitleSettingSelectBoxConfig>
    BackgroundOpacitySelectBox?: Partial<SubtitleSettingSelectBoxConfig>
    BufferingOverlay?: Partial<BufferingOverlayConfig>
    Button?: Partial<ButtonConfig>
    CastStatusOverlay?: Partial<ContainerConfig>
    CastToggleButton?: Partial<ToggleButtonConfig>
    CastUIContainer?: Partial<UIContainerConfig>
    CharacterEdgeColorSelectBox?: Partial<SubtitleSettingSelectBoxConfig>
    CharacterEdgeSelectBox?: Partial<SubtitleSettingSelectBoxConfig>
    ClickOverlay?: Partial<ClickOverlayConfig>
    CloseButton?: Partial<CloseButtonConfig>
    Component?: Partial<ComponentConfig>
    Container?: Partial<ContainerConfig>
    ContextMenu?: Partial<ContextMenuConfig>
    ControlBar?: Partial<ControlBarConfig>
    DismissClickOverlay?: Partial<DismissClickOverlayConfig>
    DynamicSettingsPanelItem?: Partial<DynamicSettingsPanelItemConfig>
    EcoModeContainer?: Partial<ContainerConfig>
    EcoModeToggleButton?: Partial<ToggleButtonConfig>
    ErrorMessageOverlay?: Partial<ErrorMessageOverlayConfig>
    FontColorSelectBox?: Partial<SubtitleSettingSelectBoxConfig>
    FontFamilySelectBox?: Partial<SubtitleSettingSelectBoxConfig>
    FontOpacitySelectBox?: Partial<SubtitleSettingSelectBoxConfig>
    FontSizeSelectBox?: Partial<SubtitleSettingSelectBoxConfig>
    FontStyleSelectBox?: Partial<SubtitleSettingSelectBoxConfig>
    FullscreenToggleButton?: Partial<ToggleButtonConfig>
    HugePlaybackToggleButton?: Partial<PlaybackToggleButtonConfig>
    HugeReplayButton?: Partial<ButtonConfig>
    Icon?: Partial<ComponentConfig>
    InteractiveContextMenuItem?: Partial<InteractiveContextMenuItemConfig>
    InteractiveSettingsPanelItem?: Partial<SettingsPanelItemConfig>
    ItemSelectionList?: Partial<ListSelectorConfig>
    Label?: Partial<LabelConfig>
    ListBox?: Partial<ListBoxConfig>
    ListSelector?: Partial<ListSelectorConfig>
    MetadataLabel?: Partial<MetadataLabelConfig>
    PersistentPreferencesToggleButton?: Partial<ToggleButtonConfig>
    PictureInPictureToggleButton?: Partial<ToggleButtonConfig>
    PlaybackSpeedSelectBox?: Partial<ListSelectorConfig>
    PlaybackTimeLabel?: Partial<PlaybackTimeLabelConfig>
    PlaybackToggleButton?: Partial<PlaybackToggleButtonConfig>
    PlaybackToggleOverlay?: Partial<PlaybackToggleOverlayConfig>
    PlayerContextMenu?: Partial<PlayerContextMenuConfig>
    PlayerInsightsPanel?: Partial<PlayerInsightsPanelConfig>
    QuickSeekButton?: Partial<QuickSeekButtonConfig>
    RecommendationItem?: Partial<RecommendationItemConfig>
    RecommendationOverlay?: Partial<ContainerConfig>
    ReplayButton?: Partial<ButtonConfig>
    SeekBar?: Partial<SeekBarConfig>
    SeekBarLabel?: Partial<SeekBarLabelConfig>
    SelectBox?: Partial<ListSelectorConfig>
    SettingsPanel?: Partial<SettingsPanelConfig>
    SettingsPanelItem?: Partial<SettingsPanelItemConfig>
    SettingsPanelPage?: Partial<SettingsPanelPageConfig>
    SettingsPanelPageBackButton?: Partial<SettingsPanelPageNavigatorConfig>
    SettingsPanelPageNavigatorButton?: Partial<SettingsPanelPageNavigatorConfig>
    SettingsPanelPageOpenButton?: Partial<SettingsPanelPageNavigatorConfig>
    SettingsPanelSelectOption?: Partial<SettingsPanelSelectOptionConfig>
    SettingsPanelSeparator?: Partial<SettingsPanelSeparatorConfig>
    SettingsToggleButton?: Partial<SettingsToggleButtonConfig>
    SmallCenteredPlaybackToggleButton?: Partial<PlaybackToggleButtonConfig>
    Spacer?: Partial<ComponentConfig>
    SubtitleListBox?: Partial<SubtitleListBoxConfig>
    SubtitleOverlay?: Partial<SubtitleOverlayConfig>
    SubtitleSelectBox?: Partial<ListSelectorConfig>
    SubtitleSettingSelectBox?: Partial<SubtitleSettingSelectBoxConfig>
    SubtitleSettingsPanelPage?: Partial<SubtitleSettingsPanelPageConfig>
    SubtitleSettingsResetButton?: Partial<ButtonConfig>
    TitleBar?: Partial<TitleBarConfig>
    ToggleButton?: Partial<ToggleButtonConfig>
    ToggleSettingsPanelItem?: Partial<ToggleSettingsPanelItem>
    TouchControlOverlay?: Partial<TouchControlOverlayConfig>
    TvNoiseCanvas?: Partial<ComponentConfig>
    UIContainer?: Partial<UIContainerConfig>
    VideoQualitySelectBox?: Partial<ListSelectorConfig>
    VolumeControlButton?: Partial<VolumeControlButtonConfig>
    VolumeSlider?: Partial<VolumeSliderConfig>
    VolumeToggleButton?: Partial<ToggleButtonConfig>
    VRToggleButton?: Partial<ToggleButtonConfig>
    Watermark?: Partial<WatermarkConfig>
    WindowColorSelectBox?: Partial<SubtitleSettingSelectBoxConfig>
    WindowOpacitySelectBox?: Partial<SubtitleSettingSelectBoxConfig>

    Settings

    Member Visibility

    On This Page

    UI variants
    Components
    AdClickOverlayAdControlBarAdCounterLabelAdMessageLabelAdSkipButtonAdStatusOverlayAirPlayToggleButtonAudioQualitySelectBoxAudioTrackListBoxAudioTrackSelectBoxBackgroundColorSelectBoxBackgroundOpacitySelectBoxBufferingOverlayButtonCastStatusOverlayCastToggleButtonCastUIContainerCharacterEdgeColorSelectBoxCharacterEdgeSelectBoxClickOverlayCloseButtonComponentContainerContextMenuControlBarDismissClickOverlayDynamicSettingsPanelItemEcoModeContainerEcoModeToggleButtonErrorMessageOverlayFontColorSelectBoxFontFamilySelectBoxFontOpacitySelectBoxFontSizeSelectBoxFontStyleSelectBoxFullscreenToggleButtonHugePlaybackToggleButtonHugeReplayButtonIconInteractiveContextMenuItemInteractiveSettingsPanelItemItemSelectionListLabelListBoxListSelectorMetadataLabelPersistentPreferencesToggleButtonPictureInPictureToggleButtonPlaybackSpeedSelectBoxPlaybackTimeLabelPlaybackToggleButtonPlaybackToggleOverlayPlayerContextMenuPlayerInsightsPanelQuickSeekButtonRecommendationItemRecommendationOverlayReplayButtonSeekBarSeekBarLabelSelectBoxSettingsPanelSettingsPanelItemSettingsPanelPageSettingsPanelPageBackButtonSettingsPanelPageNavigatorButtonSettingsPanelPageOpenButtonSettingsPanelSelectOptionSettingsPanelSeparatorSettingsToggleButtonSmallCenteredPlaybackToggleButtonSpacerSubtitleListBoxSubtitleOverlaySubtitleSelectBoxSubtitleSettingSelectBoxSubtitleSettingsPanelPageSubtitleSettingsResetButtonTitleBarToggleButtonToggleSettingsPanelItemTouchControlOverlayTvNoiseCanvasUIContainerVideoQualitySelectBoxVolumeControlButtonVolumeSliderVolumeToggleButtonVRToggleButtonWatermarkWindowColorSelectBoxWindowOpacitySelectBox