Class PlayerInstance

constructor

• new PlayerInstance(container, options): PlayerInstance

• Parameters

  • container: HTMLElement
  • options: PlayerOptions

  Returns PlayerInstance

core

store

pluginManager

play

• play(): Promise<PlayerInstance>

• Returns Promise<PlayerInstance>

pause

• pause(): PlayerInstance

• Returns PlayerInstance

load

• load(): PlayerInstance

• Returns PlayerInstance

getCurrentTime

• getCurrentTime(): number

• Returns number

setCurrentTime

• setCurrentTime(time): PlayerInstance

• Parameters

  • time: number

  Returns PlayerInstance

getDuration

• getDuration(): number

• Returns number

getVolume

• getVolume(): number

• Returns number

setVolume

• setVolume(volume): PlayerInstance

• Parameters

  • volume: number

  Returns PlayerInstance

getMuted

• getMuted(): boolean

• Returns boolean

setMuted

• setMuted(muted): PlayerInstance

• Parameters

  • muted: boolean

  Returns PlayerInstance

getPlaybackRate

• getPlaybackRate(): number

• Returns number

setPlaybackRate

• setPlaybackRate(rate): PlayerInstance

• Parameters

  • rate: number

  Returns PlayerInstance

getPaused

• getPaused(): boolean

• Returns boolean

getEnded

• getEnded(): boolean

• Returns boolean

getReadyState

• getReadyState(): number

• Returns number

getNetworkState

• getNetworkState(): number

• Returns number

getError

• getError(): null | MediaError

• Returns null | MediaError

getState

• getState(): PlayerState

• Returns PlayerState

setState

• setState(state): void

• Parameters

  • state: Partial<PlayerState>

  Returns void

on

• on<T>(event, callback): (() => void)

• Type Parameters

  • T extends PlayerEventType

  Parameters

  • event: T
  • callback: ((event) => void)
    • • (event): void

      • Parameters

        • event: PlayerEventBase<T>

        Returns void

  Returns (() => void)

  • • (): void

    • Returns void

off

• off<T>(event, callback): void

• Type Parameters

  • T extends PlayerEventType

  Parameters

  • event: T
  • callback: ((event) => void)
    • • (event): void

      • Parameters

        • event: PlayerEventBase<T>

        Returns void

  Returns void

emit

• emit<T>(event, data?): PlayerInstance

• Type Parameters

  • T extends PlayerEventType

  Parameters

  • event: T
  • Optional data: EventPayloadMap[T]

  Returns PlayerInstance

use

• use(plugin): PlayerInstance

• Parameters

  • plugin: PluginDefinition<unknown, unknown>

  Returns PlayerInstance

unuse

• unuse(pluginId): PlayerInstance

• Parameters

  • pluginId: string

  Returns PlayerInstance

getPlugin

• getPlugin(pluginId): undefined | PluginDefinition<unknown, unknown>

• Parameters

  • pluginId: string

  Returns undefined | PluginDefinition<unknown, unknown>

getContainer

• getContainer(): HTMLElement

• Returns HTMLElement

getVideoElement

• getVideoElement(): HTMLVideoElement

• Returns HTMLVideoElement

requestFullscreen

• requestFullscreen(): Promise<PlayerInstance>

• Returns Promise<PlayerInstance>

exitFullscreen

• exitFullscreen(): Promise<PlayerInstance>

• Returns Promise<PlayerInstance>

isFullscreen

• isFullscreen(): boolean

• Returns boolean

requestPictureInPicture

• requestPictureInPicture(): Promise<PictureInPictureWindow>

• Returns Promise<PictureInPictureWindow>

exitPictureInPicture

• exitPictureInPicture(): Promise<PlayerInstance>

• Returns Promise<PlayerInstance>

isPictureInPicture

• isPictureInPicture(): boolean

• Returns boolean

subscribe

• subscribe(callback, keys?): (() => void)

• Parameters

  • callback: ((state) => void)
    • • (state): void

      • Parameters

        • state: PlayerState

        Returns void

  • Optional keys: (keyof PlayerState)[]

  Returns (() => void)

  • • (): void

    • Returns void

updateUIMode

• updateUIMode(uiMode): PlayerInstance

• Parameters

  • uiMode: UIMode

  Returns PlayerInstance

updateUIConfig

• updateUIConfig(config): PlayerInstance

• Parameters

  • config: ControlBarConfig

  Returns PlayerInstance

updateUITheme

• updateUITheme(theme): PlayerInstance

• Parameters

  • theme: PlayerTheme

  Returns PlayerInstance

getUIMode

• getUIMode(): UIMode

• Returns UIMode

getInfo

• getInfo(): {
      version: string;
      lifecycle: string;
      plugins: string[];
      state: PlayerState;
      uiMode: UIMode;
  }

• Returns {
      version: string;
      lifecycle: string;
      plugins: string[];
      state: PlayerState;
      uiMode: UIMode;
  }

  • version: string

  • lifecycle: string

  • plugins: string[]

  • state: PlayerState

  • uiMode: UIMode

destroy

• destroy(): void

• Returns void

setDebug

• setDebug(enabled): void

• Parameters

  • enabled: boolean

  Returns void