Class SeekBar

constructor

• new SeekBar(config?): SeekBar

• Parameters

  • config: SeekBarConfig = {}

  Returns SeekBar

Static ReadonlySMOOTH_PLAYBACK_POSITION_UPDATE_DISABLED

onSeek

• get onSeek(): Event<SeekBar, NoArgs>

• Gets the event that is fired when a scrubbing seek operation is started.

  Returns Event<SeekBar, NoArgs>

onSeekPreview

• 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>

onSeeked

• 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>

configure

• configure(player, uimanager, configureSeek?): void

• 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
  • configureSeek: boolean = true

  Returns void

getLabel

• getLabel(): SeekBarLabel

• Gets the label of this seek bar.

  Returns SeekBarLabel

  the label if this seek bar has a label, else null

hasLabel

• hasLabel(): boolean

• Checks if the seek bar has a SeekBarLabel.

  Returns boolean

  true if the seek bar has a label, else false

initialize

• initialize(): 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

isSeeking

• isSeeking(): boolean

• Checks if the seek bar is currently in the seek state.

  Returns boolean

  true if in seek state, else false

isTouchEvent

• isTouchEvent(e): e is TouchEvent

• Checks if TouchEvent is supported.

  Parameters

  • e: UIEvent

  Returns e is TouchEvent

  true if TouchEvent not undefined, else false

release

• release(): 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

setBufferPosition

• setBufferPosition(percent): void

• Sets the position until which media is buffered.

  Parameters

  • percent: number

    a number between 0 and 100

  Returns void

setPlaybackPosition

• setPlaybackPosition(percent): void

• Sets the position of the playback position indicator.

  Parameters

  • percent: number

    a number between 0 and 100 as returned by the player

  Returns void

setSeekPosition

• setSeekPosition(percent): void

• Sets the position where a seek, if executed, would jump to.

  Parameters

  • percent: number

    a number between 0 and 100

  Returns void

setSeeking

• setSeeking(seeking): 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