Class VideoPlugin

Readonlyconfig

addEventListener

• addEventListener<
      T extends "progress"
      | "play-pause"
      | "volume-change"
      | "buffer",
      E extends VideoPluginEvents & { type: T },
  >(
      type: T,
      callback: EventListenerObject | ((e: E) => void),
      options?: boolean | AddEventListenerOptions,
  ): void

  Type Parameters

  • T extends "progress" | "play-pause" | "volume-change" | "buffer"

    the name of event
  • E extends VideoPluginEvents & { type: T }

    the class of the event

  Parameters

  • type: T
  • callback: EventListenerObject | ((e: E) => void)
  • Optionaloptions: boolean | AddEventListenerOptions

  Returns void

dispatchEvent

• dispatchEvent(e: VideoPluginEvents): boolean

  Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

  MDN Reference

  Parameters

  • e: VideoPluginEvents

  Returns boolean

removeEventListener

• removeEventListener<
      T extends "progress"
      | "play-pause"
      | "volume-change"
      | "buffer",
      E extends VideoPluginEvents & { type: T },
  >(
      type: "progress" | "play-pause" | "volume-change" | "buffer",
      callback: EventListenerObject | ((e: E) => void),
      options?: boolean | EventListenerOptions,
  ): void

  Type Parameters

  • T extends "progress" | "play-pause" | "volume-change" | "buffer"

    the name of event
  • E extends VideoPluginEvents & { type: T }

    the class of the event

  Parameters

  • type: "progress" | "play-pause" | "volume-change" | "buffer"
  • callback: EventListenerObject | ((e: E) => void)
  • Optionaloptions: boolean | EventListenerOptions

  Returns void

setOption

• setOption<T extends string | number | symbol>(option: T, value: never[T]): void

  Update options

  Type Parameters

  • T extends string | number | symbol

  Parameters

  • option: T
  • value: never[T]

  Returns void

setOptions

• setOptions(options: never): void

  Update options

  Parameters

  • options: never

  Returns void