bitmovin-player-ui
    Preparing search index...

    Interface UIComponentConfigMap

    Component config overrides keyed by public component class name.

    Each property matches a public component class name. The value type is the component-specific constructor config.

    interface UIComponentConfigMap {
        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>;
    }

    Hierarchy (View Summary)

    Index

    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?

    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>