Interface PlayerEventListener

Player のイベント

Player events

interface PlayerEventListener {
    onDispose?(): void;
    onMediaElementSet?(el): void;
    onMediaSeek?(position): void;
    onPause?(): void;
    onPlay?(): void;
    onSeek?(position): void;
    onSeekComplete?(position): void;
    onStop?(): void;
    onThrottledTimeUpdate?(position): void;
    onTimeUpdate?(position): void;
    onTimerReady?(timer): void;
    onVideoReady?(v): void;
    onVideoSeek?(position): void;
    onVideoSeekEnd?(): void;
    onVideoSeekStart?(): void;
    onVolumeUpdate?(volume): void;
}

Methods

onDispose? onMediaElementSet? onMediaSeek? onPause? onPlay? onSeek? onSeekComplete? onStop? onThrottledTimeUpdate? onTimeUpdate? onTimerReady? onVideoReady? onVideoSeek? onVideoSeekEnd? onVideoSeekStart? onVolumeUpdate?

Methods

Optional onDispose

  • onDispose(): void

  • プレイヤーが破棄されるときに呼ばれる

    Called when the player is disposed

    Returns void

Optional onMediaElementSet

  • onMediaElementSet(el): void

  • 音源メディアの配置先となるDOM要素が変更されたときに呼ばれる

    Called when the media element is updated

    Parameters

    • el: HTMLElement

      音源メディアの配置先となるDOM要素 / Media element

    Returns void

Optional onMediaSeek

  • onMediaSeek(position): void

  • 楽曲の再生位置が変更されたときに呼ばれる

    Called when the media playback position is updated

    Parameters

    • position: number

      再生位置 [ms]

    Returns void

Optional onPause

  • onPause(): void

  • 再生が一時停止されたときに呼ばれる

    Called when the playback is paused

    Returns void

Optional onPlay

  • onPlay(): void

  • 再生が始まったときに呼ばれる

    Called when the playback starts

    Returns void

Optional onSeek

  • onSeek(position): void

  • 楽曲の再生位置がユーザ操作によって変更されたときに呼ばれる

    Called when the media playback position is manually updated

    Parameters

    • position: number

      再生位置 [ms]

    Returns void

Optional onSeekComplete

  • onSeekComplete(position): void

  • 楽曲の再生位置変更が完了したときに呼ばれる

    Called when the media playback position is successfully updated after onSeek

    Parameters

    • position: number

      再生位置 [ms]

    Returns void

Optional onStop

  • onStop(): void

  • 再生が停止されたときに呼ばれる

    Called when the playback stops

    Returns void

Optional onThrottledTimeUpdate

  • onThrottledTimeUpdate(position): void

  • 動画の再生位置が変更されたときに呼ばれる（あまりに頻繁な発火を防ぐため一定間隔に間引かれる）

    Called when the playback position is updated (throttled)

    Parameters

    • position: number

      再生位置 [ms]

    Returns void

Optional onTimeUpdate

  • onTimeUpdate(position): void

  • 動画の再生位置が変更されたときに呼ばれる

    Called when the playback position is updated

    Parameters

    • position: number

      再生位置 [ms]

    Returns void

Optional onTimerReady

  • onTimerReady(timer): void

  • 動画を再生するための Timer の準備が整ったときに呼ばれる

    Called when Timer is ready for playback

    Parameters

    • timer: Timer

      Timer オブジェクト / Timer object

    Returns void

Optional onVideoReady

  • onVideoReady(v): void

  • 動画オブジェクトの準備が整ったときに呼ばれる

    Called when a video object is constructed

    Parameters

    • v: IVideo

      動画オブジェクト / Video object

    Returns void

Optional onVideoSeek

  • onVideoSeek(position): void

  • 動画のシーク操作が行われたときに呼ばれる

    Called when the video position is updated

    Parameters

    • position: number

      再生位置 [ms]

    Returns void

Optional onVideoSeekEnd

  • onVideoSeekEnd(): void

  • 動画のシーク操作が終わったときに呼ばれる

    Called when the seeking operation ends

    Returns void

Optional onVideoSeekStart

  • onVideoSeekStart(): void

  • 動画のシーク操作が始まったときに呼ばれる

    Called when the seeking operation starts

    Returns void

Optional onVolumeUpdate

  • onVolumeUpdate(volume): void

  • 音量が変更されたときに呼ばれる

    Called when the player volume is updated

    Parameters

    • volume: number

      音量 / Volume [0-100]

    Returns void

Settings

Member Visibility

Theme

On This Page

onDisposeonMediaElementSetonMediaSeekonPauseonPlayonSeekonSeekCompleteonStoponThrottledTimeUpdateonTimeUpdateonTimerReadyonVideoReadyonVideoSeekonVideoSeekEndonVideoSeekStartonVolumeUpdate