Interface SessionUiEventData

The session UI event data which appears as an event's detail property.

interface SessionUiEventData {
    adClickthroughUrl?: string;
    adCountdown?: AdCountdown;
    adElapsedTime?: number;
    adObject?: AdObject;
    failedAdTrackingInfoRequest?: boolean;
    nonLinearAdsObject?: NonLinearAdsObject;
    timeToNextAd?: number;
}

Properties

adClickthroughUrl? adCountdown? adElapsedTime? adObject? failedAdTrackingInfoRequest? nonLinearAdsObject? timeToNextAd?

Properties

Optional adClickthroughUrl

adClickthroughUrl?: string

The URL to follow when ad click-through happens.

Optional adCountdown

adCountdown?: AdCountdown

The countdown timers related to the current ad.

Optional adElapsedTime

adElapsedTime?: number

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

Optional adObject

adObject?: AdObject

The ad object which is the subject of the corresponding UI event.

Optional failedAdTrackingInfoRequest

failedAdTrackingInfoRequest?: boolean

Whether the corresponding ad tracking info request has failed.

Optional nonLinearAdsObject

nonLinearAdsObject?: NonLinearAdsObject

The nonlinear ad object which is the subject of the corresponding UI event.

Optional timeToNextAd

timeToNextAd?: number

The time interval (in seconds) between the current playhead position and the next ad.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc