OGPlayer Web SDK
    Preparing search index...

    Interface PlaybackListener

    Playback lifecycle callbacks. All members optional.

    interface PlaybackListener {
        onDrmSessionRenewed?(reason: DrmRenewalReason): void;
        onError?(error: OGPlayerError): void;
        onIsPlayingChanged?(isPlaying: boolean): void;
        onLiveEdgeChanged?(atLiveEdge: boolean): void;
        onMutedAutoplayFallback?(): void;
        onPause?(): void;
        onPipChanged?(isActive: boolean): void;
        onPlay?(): void;
        onPlaybackCompleted?(): void;
        onPlaylistItemChanged?(index: number, item: OGMediaItem): void;
        onPlaylistItemSkipped?(fromIndex: number, toIndex: number): void;
        onProgress?(
            positionMs: number,
            bufferedMs: number,
            durationMs: number,
        ): void;
        onResume?(): void;
        onSeekCompleted?(positionMs: number): void;
        onSeekStarted?(fromMs: number, toMs: number): void;
        onStateChanged?(state: PlaybackState): void;
    }
    Index
    onDrmSessionRenewed? onError? onIsPlayingChanged? onLiveEdgeChanged? onMutedAutoplayFallback? onPause? onPipChanged? onPlay? onPlaybackCompleted? onPlaylistItemChanged? onPlaylistItemSkipped? onProgress? onResume? onSeekCompleted? onSeekStarted? onStateChanged?

    • Parameters

      • isPlaying: boolean

      Returns void

    • Parameters

      • atLiveEdge: boolean

      Returns void

    • The browser blocked autoplay-with-audio and fallbackToMutedAutoplay restarted playback muted — show your own unmute affordance.

      Returns void

    • The video entered (true) or left (false) picture-in-picture — through enterPip()/exitPip(), the browser's own auto-enter or its PiP window's close button alike.

      Parameters

      • isActive: boolean

      Returns void

    • A playlist item became current — fired for the start item of loadPlaylist, every auto-advance, every skipToNext() and every skipToPrevious().

      Parameters

      Returns void

    • The user skipped via skipToNext() (the "Up next" card's tap, the remote's next key) or skipToPrevious() (toIndex < fromIndex) — fired before the resulting onPlaylistItemChanged. Auto-advances at the end of an item do NOT fire this, so analytics can tell an impatient skip from natural completion.

      Parameters

      • fromIndex: number
      • toIndex: number

      Returns void

    • Parameters

      • positionMs: number
      • bufferedMs: number
      • durationMs: number

      Returns void

    • Parameters

      • positionMs: number

      Returns void

    • Parameters

      • fromMs: number
      • toMs: number

      Returns void

    Settings
    Member Visibility

    On This Page
    Methods