Interface AdObserver

The ad observer interface which receive notifications from the playback session tracker.

interface AdObserver {
    onAdBeaconResponse?(adData, beaconInfo, beaconUrl, status): void;
    onAdClick?(adData): void;
    onAdEnd?(adData): void;
    onAdLoad?(adData): void;
    onAdProgress?(adData, adElapsedTime, playhead): void;
    onAdStart?(adData, adElapsedTime, playhead): void;
    onAdTrackingEvent?(adData, adTrackingEvent): void;
    onNewAd?(adData): void;
    onNewNonLinearAds?(adData): void;
    onNonLinearAdsEnd?(adData): void;
    onNonLinearAdsStart?(adData, adElapsedTime, playhead): void;
    onTrackingInfoResponse?(failed): void;
}

Methods

onAdBeaconResponse? onAdClick? onAdEnd? onAdLoad? onAdProgress? onAdStart? onAdTrackingEvent? onNewAd? onNewNonLinearAds? onNonLinearAdsEnd? onNonLinearAdsStart? onTrackingInfoResponse?

Methods

Optional onAdBeaconResponse

  • onAdBeaconResponse(adData, beaconInfo, beaconUrl, status): void

  • For the tracker to notify about the response status of an ad-beacon request.

    Parameters

    • adData: AdData

      The corresponding ad data object.

    • beaconInfo: any

      The ad-beacon related information.

    • beaconUrl: string

      The ad-beacon request URL.

    • status: number

      The HTTP status of the response of an ad-beacon request.

    Returns void

Optional onAdClick

  • onAdClick(adData): void

  • For the tracker to notify about the current ad being clicked.

    Parameters

    • adData: AdData

      The corresponding ad data object.

    Returns void

Optional onAdEnd

  • onAdEnd(adData): void

  • For the tracker to notify about the end of playback of an ad.

    Parameters

    • adData: AdData

      The corresponding ad data object.

    Returns void

Optional onAdLoad

  • onAdLoad(adData): void

  • For the tracker to notify about an ad being loaded (playback will start soon).

    Parameters

    • adData: AdData

      The corresponding ad data object.

    Returns void

Optional onAdProgress

  • onAdProgress(adData, adElapsedTime, playhead): void

  • For the tracker to notify about the progress of playback of an ad.

    Parameters

    • adData: AdData

      The corresponding ad data object.

    • adElapsedTime: number

      The time difference (in seconds) between the current playhead position and the first frame of the ad.

    • playhead: number

      The current playhead position as the elapsed time on the media timeline, in seconds.

    Returns void

Optional onAdStart

  • onAdStart(adData, adElapsedTime, playhead): void

  • For the tracker to notify about the start of playback of an ad.

    Parameters

    • adData: AdData

      The corresponding ad data object.

    • adElapsedTime: number

      The time difference (in seconds) between the current playhead position and the first frame of the ad.

    • playhead: number

      The current playhead position as the elapsed time on the media timeline, in seconds.

    Returns void

Optional onAdTrackingEvent

  • onAdTrackingEvent(adData, adTrackingEvent): void

  • For the tracker to notify about an ad tracking event.

    Parameters

    • adData: AdData

      The corresponding ad data object.

    • adTrackingEvent: AdTrackingEvent

      The ad tracking event that just occurred.

    Returns void

Optional onNewAd

  • onNewAd(adData): void

  • For the tracker to notify about a new ad data coming into existence.

    Parameters

    • adData: AdData

      The newly created ad data object.

    Returns void

Optional onNewNonLinearAds

  • onNewNonLinearAds(adData): void

  • For the tracker to notify about a new nonlinear ad data coming into existence.

    Parameters

    Returns void

Optional onNonLinearAdsEnd

  • onNonLinearAdsEnd(adData): void

  • For the tracker to notify about the end of a nonlinear ad.

    Parameters

    Returns void

Optional onNonLinearAdsStart

  • onNonLinearAdsStart(adData, adElapsedTime, playhead): void

  • For the tracker to notify about the start of a nonlinear ad.

    Parameters

    • adData: NonLinearAdsData

      The corresponding nonlinear ad data object.

    • adElapsedTime: number

      The time difference (in seconds) between the current playhead position and the start of the nonlinear ad.

    • playhead: number

      The current playhead position as the elapsed time on the media timeline, in seconds.

    Returns void

Optional onTrackingInfoResponse

  • onTrackingInfoResponse(failed): void

  • For the tracker to notify about the end of processing of an ad tracking info response.

    Parameters

    • failed: boolean

      Whether the response indicates a failed ad tracking info request.

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc