Enumeration SessionUiEvent

The session UI event types.

Enumeration Members

AD_CAN_SKIP AD_CLICK AD_END AD_INCOMING AD_PROGRESS AD_START AD_TRACKING_INFO_RESPONSE NONLINEAR_AD_END NONLINEAR_AD_START

Enumeration Members

AD_CAN_SKIP

AD_CAN_SKIP: "ad_can_skip"

The user now has the option to skip the ad. A SessionUiEventData object (with adObject in it) is assigned to the event's detail property.

AD_CLICK

AD_CLICK: "ad_click"

A user click over the ad has been detected. A SessionUiEventData object (with adObject and an optional adClickthroughUrl in it) is assigned to the event's detail property.

AD_END

AD_END: "ad_end"

The ad presentation has ended. A SessionUiEventData object (with adObject in it) is assigned to the event's detail property.

AD_INCOMING

AD_INCOMING: "ad_incoming"

An incoming ad is within the SessionConfiguration#incomingAdCountdownInterval from the current playhead position. A SessionUiEventData object (with timeToNextAd in it) is assigned to the event's detail property.

AD_PROGRESS

AD_PROGRESS: "ad_progress"

The ad presentation has made some progress. A SessionUiEventData object (with adObject, adElapsedTime and adCountdown in it) is assigned to the event's detail property.

AD_START

AD_START: "ad_start"

The ad presentation has started. A SessionUiEventData object (with adObject, adElapsedTime and adCountdown in it) is assigned to the event's detail property.

AD_TRACKING_INFO_RESPONSE

AD_TRACKING_INFO_RESPONSE: "ad_tracking_info_response"

The processing of an ad tracking info response was finished. A SessionUiEventData object (with failedAdTrackingInfoRequest set to true or false) is assigned to the event's detail property.

NONLINEAR_AD_END

NONLINEAR_AD_END: "nonlinear_ad_end"

The nonlinear ad has ended. A SessionUiEventData object (with nonLinearAdsObject in it) is assigned to the event's detail property.

NONLINEAR_AD_START

NONLINEAR_AD_START: "nonlinear_ad_start"

The nonlinear ad has started. A SessionUiEventData object (with nonLinearAdsObject and adElapsedTime in it) is assigned to the event's detail property.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc