bitmovin-player-ui
    Preparing search index...

    Class AdControlBar

    Contains player control components displayed during ad playback, e.g., play toggle button, seek bar, volume control, fullscreen toggle button.

    Usage: Pass one or more Container components via the components array.

    • Containers containing a SeekBar (directly or nested) are always shown.
    • Other containers are hidden/shown when controls hide.
    new AdControlBar({
      components: [
        new Container({
          components: [
            new AdCounterLabel(),
            new SeekBar({ label: new SeekBarLabel() }),
            new PlaybackTimeLabel({ timeLabelMode: PlaybackTimeLabelMode.RemainingTime }),
          ],
          cssClasses: ['ad-controlbar-top'],
        }),
        new Container({
          components: [
            new PlaybackToggleButton(),
            new VolumeToggleButton(),
            new Spacer(),
            new FullscreenToggleButton(),
          ],
          cssClasses: ['ad-controlbar-bottom'],
        }),
      ],
    })

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Accessors

    onDisabled onEnabled onFocusedChanged onHide onHoverChanged onShow onViewModeChanged

    Methods

    addComponent configure disable enable getComponents getConfig getDomElement hasDomElement hide initialize isDisabled isEnabled isHidden isHovered isShown prependComponent release removeComponent removeComponents setAriaAttr setAriaLabel show toggleHidden updateComponents

    Constructors

    Accessors

    • get onDisabled(): Event<Component<Config>, NoArgs>

      Gets the event that is fired when the component is disabling. See the detailed explanation on event architecture on the #componentEvents events list.

      Returns Event<Component<Config>, NoArgs>

    Methods

    • Configures the component for the supplied Player and UIInstanceManager. This is the place where all the magic happens, where components typically subscribe and react to events (on their DOM element, the Player, or the UIInstanceManager), and basically everything that makes them interactive. This method is called only once, when the UIManager initializes the UI.

      Subclasses usually overwrite this method to add their own functionality.

      Parameters

      • player: PlayerAPI

        the player which this component controls

      • uimanager: UIInstanceManager

        the UIInstanceManager that manages this component

      Returns void

    • Disables the component. This method basically transfers the component into the disabled state. Actual disabling is done via CSS or child components. (e.g. Button needs to unsubscribe click listeners)

      Returns void

    • Enables the component. This method basically transfers the component into the enabled state. Actual enabling is done via CSS or child components. (e.g. Button needs to subscribe click listeners)

      Returns void

    • Initializes the component, e.g. by applying config settings. This method must not be called from outside the UI framework.

      This method is automatically called by the UIInstanceManager. If the component is an inner component of some component, and thus encapsulated abd managed internally and never directly exposed to the UIManager, this method must be called from the managing component's #initialize method.

      Returns void

    • Releases all resources and dependencies that the component holds. Player, DOM, and UIManager events are automatically removed during release and do not explicitly need to be removed here. This method is called by the UIManager when it releases the UI.

      Subclasses that need to release resources should override this method and call super.release().

      Returns void

    • Updates the DOM of the container with the current components.

      This is called automatically after construction. However, when you dynamically add or remove components at runtime, you must call updateComponents() to re-render the container’s children.

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods