EventType

enum EventType {}

EventType: type of events that are fired during the progress of an ad slot.

  • Indicates the intial undefined state.

    Declaration

    Objective-C

    EVENT_TYPE_UNDEFINED = -1

  • Is fired when the user clicks on the ad.

    Declaration

    Objective-C

    ON_AD_CLICKED

  • Is fired when the user clicks on the ad.

    Declaration

    Objective-C

    ON_AD_CREATIVE_VIEW

  • Is fired when requesting or parsing of the manifest failed, also when ad playback failed. Check Event.errorCode (or Event.info.errorCode) and the IAB VAST 4.0 Error Codes Table for details.

    Declaration

    Objective-C

    ON_AD_ERROR

  • Is fired when a single ad has been stopped. _(!) Double‐check the attribute adVariant to find out whether this is the last ad or see {@code ON_AD_SLOTCOMPLETE}.

    Declaration

    Objective-C

    ON_AD_FINISHED

  • Is fired when the playback of a single ad has reached 25%.

    Declaration

    Objective-C

    ON_AD_FIRST_QUARTILE

  • Is fired when the user‐visible phase of the ad has begun.

    Declaration

    Objective-C

    ON_AD_IMPRESSION

  • Is fired when a VPAID ad changes its linearity.

    Declaration

    Objective-C

    ON_AD_LINEARITY_CHANGE

  • Is fired when the ad manifest (VAST tag) has been loaded.

    Declaration

    Objective-C

    ON_AD_MANIFEST_LOADED

  • Is fired when the playback of a single ad has reached 50%.

    Declaration

    Objective-C

    ON_AD_MID_POINT

  • Is fired when the playback of a single ad has reached 50%.

    Declaration

    Objective-C

    ON_AD_MUTED

  • Is fired when the playback of a single ad has been paused.

    Declaration

    Objective-C

    ON_AD_PAUSED

  • Is fired when the playback of a single ad has been finished and reached 100%.

    Declaration

    Objective-C

    ON_AD_PLAYBACK_FINISHED

  • Is fired when the playback of a single ad has been started, 0%.

    Declaration

    Objective-C

    ON_AD_PLAYBACK_START

  • Is fired when the playback of a single ad has been resumed.

    Declaration

    Objective-C

    ON_AD_PLAYING

  • Is fired when the playback of a single ad has been resumed.

    Declaration

    Objective-C

    ON_AD_PROGRESS

  • Is fired when an ad manifest (VAST tag) was parsed and the ads have been added onto the queue.

    Declaration

    Objective-C

    ON_AD_SCHEDULED

  • Is fired when an ad manifest (VAST tag) was parsed and the ads have been added onto the queue.

    Declaration

    Objective-C

    ON_AD_SIZE_CHANGED

  • Is fired when an advertisement becomes skippable.

    Declaration

    Objective-C

    ON_AD_SKIPPABLE_STATE_CHANGE

  • Is fired when an ad has been skipped.

    Declaration

    Objective-C

    ON_AD_SKIPPED

  • Is fired when an ad‐break has been finished, regardless whether the requested ad manifest contained valid ads or not.

    Declaration

    Objective-C

    ON_AD_SLOT_COMPLETE

  • Is fired when the playback of all ads for the current ad‐break has finished, most likely after the CLOSER.

    Declaration

    Objective-C

    ON_AD_SLOT_FINISHED

  • Is fired when an ad‐break has been requested.

    Declaration

    Objective-C

    ON_AD_SLOT_START

  • Is fired when an ad‐break has been requested.

    Declaration

    Objective-C

    ON_AD_SLOT_STARTED

  • Is fired when the playback of an ad has been started.

    Declaration

    Objective-C

    ON_AD_STARTED

  • Is fired when the playback of a single ad has reached 75%.

    Declaration

    Objective-C

    ON_AD_THIRD_QUARTILE

  • Is fired when the playback of a single ad has reached 75%.

    Declaration

    Objective-C

    ON_AD_UNMUTED

  • Is fired when the playback of a single ad has reached 75%.

    Declaration

    Objective-C

    ON_AD_VOLUME_CHANGED

  • Is fired when a manifest contains ads. Companion ads can be requested through the API property adCompanions

    Declaration

    Objective-C

    ON_AD_COMPANIONS_DETECTED

  • Is fired when a manifest contains nodes. Extensions can be requested through the API property adExtensions

    Declaration

    Objective-C

    ON_EXTENSIONS_DETECTED

  • Is fired when a manifest contains nodes. Extensions can be requested through the API property adExtensions

    Declaration

    Objective-C

    ON_GENERAL_ERROR

  • Is fired once the add-on is going to request resources through HOMAD. Requires that HOMAD has been enabled during the player setup. See HOMAD Prerequisites

    Declaration

    Objective-C

    ON_HOMAD_ACTIVATION

  • Is fired when the HOMAD initialization has failed (ex: wrong clientConfig) or when HOMAD detected issues while requesting an ad.

    Declaration

    Objective-C

    ON_HOMAD_PENALTY

  • Is fired when the HOMAD initialization has failed (ex: wrong clientConfig) or when HOMAD detected issues while requesting an ad.

    Declaration

    Objective-C

    ON_ICONS_DETECTED

  • Is fired when the HOMAD initialization has failed (ex: wrong clientConfig) or when HOMAD detected issues while requesting an ad.

    Declaration

    Objective-C

    ON_ICON_CLICKED

  • Is fired when the HOMAD initialization has failed (ex: wrong clientConfig) or when HOMAD detected issues while requesting an ad.

    Declaration

    Objective-C

    ON_PLAYBACK_FINISHED

  • Is fired when the HOMAD initialization has failed (ex: wrong clientConfig) or when HOMAD detected issues while requesting an ad.

    Declaration

    Objective-C

    ON_VERFICATION_DETECTED

  • Is fired when the HOMAD initialization has failed (ex: wrong clientConfig) or when HOMAD detected issues while requesting an ad.

    Declaration

    Objective-C

    ON_AD_WARNING