Enum VideoAdEventType

  • All Implemented Interfaces:
    java.io.Serializable , kotlin.Comparable

    
    public enum VideoAdEventType
    extends Enum<VideoAdEventType>
                        

    Types of events that can occur during ad playback.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
    • Constructor Summary

      Constructors 
      Constructor Description
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      LOADED

      fired when the VAST response has been received.

      MEDIA_LOADED

      fired when the creative's media has been loaded.

      STARTED

      fired when a linear or non-linear ad starts playing.

      COMPLETED

      fired when a linear ad completes playing.

      CONTENT_PAUSE_REQUESTED

      fired when content should be paused. This usually happens right before an ad is about to hide the content.

      CONTENT_RESUME_REQUESTED

      fired when content should be resumed. This usually happens when an ad finishes or collapses.

      FIRST_QUARTILE

      fired when the ad playhead crosses first quartile.

      MID_POINT

      fired when the ad playhead crosses midpoint.

      THIRD_QUARTILE

      fired when the ad playhead crosses third quartile.

      PAUSED

      fired when an ad is paused.

      RESUMED

      fired when an ad is resumed.

      SKIPPED

      fired when an ad was skipped.

      MUTED

      fired when an ad volume has been muted.

      UNMUTED

      fired when an ad volume has been unmuted.

      AD_CLOSE_REQUESTED

      fired when ad should be closed.

      AD_PROGRESS

      fired to inform of ad progress and can be used by publisher to display a countdown timer.

      AD_CLICKED

      fired when a linear or non-linear ad is clicked.

      AD_CLICKED_BUT_NOT_WORK

      fired when an ad clicked but not worked due to empty click through url.

      RESUME_CLICKED

      fired when a resume button is clicked.

      PAUSE_CLICKED

      fired when a pause button is clicked.

      REWIND_CLICKED

      fired when a rewind button is clicked.

      AD_BUFFERING

      fired when playback stalls while the ad buffers.

      SKIPPABLE_STATE_CHANGED

      fired when the displayed ads skippable state is changed.

      ICON_CLICKED

      the user has tapped an ad icon. On Android mobile apps, the SDK will navigate to the landing page. On Connected TV devices, the SDK will present a modal dialog containing the VAST icon fallback image.

      MUTE_CLICKED

      fired when the user activated the mute control and muted the creative.

      UNMUTE_CLICKED

      fired when the user activated the mute control and unmuted the creative.

      LOG

      fired to enable the SDK to communicate a message to be logged, which is stored in adData. This can be fired in the event of a non-fatal playback error (for example, an ad in a pod cannot be played).

      ALL_ADS_COMPLETED

      fired when the ads manager is done playing all the valid ads in the ads response, or when the response doesn't return any valid ads.

    • Method Summary

      Modifier and Type Method Description
      final VideoAdEventType valueOf(String value) Returns the enum constant of this type with the specified name.
      final Array<VideoAdEventType> values() Returns an array containing the constants of this enum type, in the order they're declared.
      final EnumEntries<VideoAdEventType> getEntries() Types of events that can occur during ad playback.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

    • Method Detail

      • valueOf

         final VideoAdEventType valueOf(String value)

        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

      • values

         final Array<VideoAdEventType> values()

        Returns an array containing the constants of this enum type, in the order they're declared.

        This method may be used to iterate over the constants.