Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "eventHandlers"

Index

Functions

Functions

Const addPlayerEventHandler

  • addPlayerEventHandler(player: PlayerAPI, eventType: PlayerEvent, callback: PlayerEventCallback): Teardown

  • Adds a Event handler to the player and returns the teardown function

    Parameters

    • player: PlayerAPI
    • eventType: PlayerEvent
    • callback: PlayerEventCallback

    Returns Teardown

Const checkChapter

  • checkChapter(mediaHeartbeat: MediaHeartbeat, p: PlayerAPI, toCreateChapterObject: PlayerWithItemProjection<ChapterObject, ChapterEvent>): (Anonymous function)

  • Parameters

    Returns (Anonymous function)

Const onVideoPause

  • Parameters

    Returns () => void

      • (): void

      • Returns void

Const onVideoPlay

  • onVideoPlay(handler: () => void): (Anonymous function)

  • Parameters

    • handler: () => void
        • (): void

        • Returns void

    Returns (Anonymous function)

Const onVideoPlaying

  • Parameters

    Returns () => void

      • (): void

      • Returns void

Const toGetBitrate

  • toGetBitrate(player: PlayerAPI): TeardownPlayerProjectionTuple<number>

  • Creates a Tuple that stores the current bitrate of playback. This is initialized to the players bitrate defined in player.getVideoQuality().bitrate, and changed when ON_VIDEO_PLAYBACK_QUALITY_CHANGED events occur. Note this may be delayed from a manual change of bitrate due to buffering or frame times the returning teardown stops tracking bitrate updates

    Parameters

    • player: PlayerAPI

    Returns TeardownPlayerProjectionTuple<number>

Const toOnAdBreakComplete

  • toOnAdBreakComplete(mediaHeartbeat: MediaHeartbeat, player: PlayerAPI, finished: () => void): (Anonymous function)

  • Parameters

    • mediaHeartbeat: MediaHeartbeat
    • player: PlayerAPI
    • finished: () => void
        • (): void

        • Returns void

    Returns (Anonymous function)

Const toOnAdBreakStart

  • toOnAdBreakStart(mediaHeartbeat: MediaHeartbeat, player: PlayerAPI, toCreateAdBreakObject: PlayerWithItemProjection<AdBreakObject, AdBreakEvent>): (Anonymous function)

  • Parameters

    Returns (Anonymous function)

Const toOnAdComplete

  • toOnAdComplete(mediaHeartbeat: MediaHeartbeat): (Anonymous function)

  • Parameters

    Returns (Anonymous function)

Const toOnAdError

  • Parameters

    Returns (Anonymous function)

Const toOnAdSkip

  • Parameters

    Returns (Anonymous function)

Const toOnAdStart

  • toOnAdStart(mediaHeartbeat: MediaHeartbeat, player: PlayerAPI, toCreateAdObject: PlayerWithItemProjection<AdObject, AdEvent>): (Anonymous function)

  • Parameters

    • mediaHeartbeat: MediaHeartbeat
    • player: PlayerAPI
    • toCreateAdObject: PlayerWithItemProjection<AdObject, AdEvent>

    Returns (Anonymous function)

Const toOnBufferEnd

  • Parameters

    Returns (Anonymous function)

Const toOnBufferStart

  • toOnBufferStart(mediaHeartbeat: MediaHeartbeat): (Anonymous function)

  • Parameters

    Returns (Anonymous function)

Const toOnError

  • Parameters

    Returns (Anonymous function)

Const toOnSeekEnd

  • Parameters

    Returns (Anonymous function)

Const toOnSeekStart

  • Parameters

    Returns (Anonymous function)

Const toOnVideoComplete

  • toOnVideoComplete(finished: () => void): (Anonymous function)

  • Parameters

    • finished: () => void
        • (): void

        • Returns void

    Returns (Anonymous function)

Const toOnVideoDestroy

  • toOnVideoDestroy(mediaHeartbeat: MediaHeartbeat): (Anonymous function)

  • Parameters

    Returns (Anonymous function)

Const toOnVideoQualityChanged

Const toRemovePlayerEventHandler

  • toRemovePlayerEventHandler(player: PlayerAPI, eventType: PlayerEvent, callback: PlayerEventCallback): Teardown

  • creates a Teardown function

    Parameters

    • player: PlayerAPI
    • eventType: PlayerEvent
    • callback: PlayerEventCallback

    Returns Teardown

    The return function when invoked will remove the event handler

Const toSourceFramerate

  • toSourceFramerate(player: PlayerAPI): number | undefined

  • Takes an instance of a Bitmovin player and provides the framerate of the current source, or undefined if no framerate is provided.

    Parameters

    • player: PlayerAPI

      Instance of the Bitmovin player

    Returns number | undefined

Const toStartUpTime

  • toStartUpTime(player: PlayerAPI): TeardownPlayerProjectionTuple<number>

  • Startup Time is defined as the delta between the ON_SOURCE_LOADED and the next ON_PLAY event.

    Parameters

    • player: PlayerAPI

    Returns TeardownPlayerProjectionTuple<number>

    The Second value of this tuple will be undefined until both events have fired once fired it will be the delta between the two events. This value should not change once defined

Generated using TypeDoc