Interface IPlayerInstance

interface IPlayerInstance {
    play(): Promise<IPlayerInstance>;
    pause(): IPlayerInstance;
    load(): IPlayerInstance;
    destroy(): void;
    getCurrentTime(): number;
    setCurrentTime(time): IPlayerInstance;
    getDuration(): number;
    getVolume(): number;
    setVolume(volume): IPlayerInstance;
    getMuted(): boolean;
    setMuted(muted): IPlayerInstance;
    getPlaybackRate(): number;
    setPlaybackRate(rate): IPlayerInstance;
    getPaused(): boolean;
    getEnded(): boolean;
    getReadyState(): number;
    getNetworkState(): number;
    getError(): null | MediaError;
    getState(): PlayerState;
    setState(state): void;
    on<T>(event, callback): (() => void);
    off<T>(event, callback): void;
    emit<T>(event, data?): IPlayerInstance;
    use(plugin): IPlayerInstance;
    unuse(pluginId): IPlayerInstance;
    getPlugin(pluginId): undefined | PluginDefinition<unknown, unknown>;
    getContainer(): HTMLElement;
    getVideoElement(): HTMLVideoElement;
    requestFullscreen(): Promise<IPlayerInstance>;
    exitFullscreen(): Promise<IPlayerInstance>;
    isFullscreen(): boolean;
    requestPictureInPicture(): Promise<PictureInPictureWindow>;
    exitPictureInPicture(): Promise<IPlayerInstance>;
    isPictureInPicture(): boolean;
    getLogger?(): Logger;
}

Methods

play pause load destroy getCurrentTime setCurrentTime getDuration getVolume setVolume getMuted setMuted getPlaybackRate setPlaybackRate getPaused getEnded getReadyState getNetworkState getError getState setState on off emit use unuse getPlugin getContainer getVideoElement requestFullscreen exitFullscreen isFullscreen requestPictureInPicture exitPictureInPicture isPictureInPicture getLogger?

Methods

play

pause

load

destroy

getCurrentTime

setCurrentTime

getDuration

getVolume

setVolume

getMuted

setMuted

getPlaybackRate

setPlaybackRate

getPaused

getEnded

getReadyState

getNetworkState

getError

getState

setState

on

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

  • Type Parameters

    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

    Parameters

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

        • Parameters

          • event: PlayerEventBase<T>

          Returns void

    Returns void

emit

use

unuse

getPlugin

getContainer

getVideoElement

requestFullscreen

exitFullscreen

isFullscreen

requestPictureInPicture

  • requestPictureInPicture(): Promise<PictureInPictureWindow>

  • Returns Promise<PictureInPictureWindow>

exitPictureInPicture

isPictureInPicture

Optional getLogger

Settings

Member Visibility

Theme

On This Page

playpauseloaddestroygetCurrentTimesetCurrentTimegetDurationgetVolumesetVolumegetMutedsetMutedgetPlaybackRatesetPlaybackRategetPausedgetEndedgetReadyStategetNetworkStategetErrorgetStatesetStateonoffemituseunusegetPlugingetContainergetVideoElementrequestFullscreenexitFullscreenisFullscreenrequestPictureInPictureexitPictureInPictureisPictureInPicturegetLogger