A simple volume slider component to adjust the player's volume setting.

Hierarchy (view full)

Constructors

Properties

SMOOTH_PLAYBACK_POSITION_UPDATE_DISABLED: -1 = -1

Accessors

  • get onSeekPreview(): Event<SeekBar, SeekPreviewEventArgs>
  • Gets the event that is fired during a scrubbing seek (to indicate that the seek preview, i.e. the video frame, should be updated), or during a normal seek preview when the seek bar is hovered (and the seek target, i.e. the seek bar label, should be updated).

    Returns Event<SeekBar, SeekPreviewEventArgs>

  • get onSeeked(): Event<SeekBar, number>
  • Gets the event that is fired when a scrubbing seek has finished or when a direct seek is issued.

    Returns Event<SeekBar, number>

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

  • Hides the component if shown. This method basically transfers the component into the hidden state. Actual hiding is done via CSS.

    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

  • Puts the seek bar into or out of seeking state by adding/removing a class to the DOM element. This can be used to adjust the styling while seeking.

    Parameters

    • seeking: boolean

      should be true when entering seek state, false when exiting the seek state

    Returns void