Package com.theoplayer.android.api.ads.ima

Enum GoogleImaAdEventType

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ALL_ADS_COMPLETED

      Fired when all the valid ads in the ads response have completed, or when the response doesn't return any valid ads.
      AD_BREAK_FETCH_ERROR

      Fired when an adbreak will not play back any ads.
      CLICKED

      Fired when an ad is clicked.
      COMPLETED

      Fired when a single ad completes playing.
      CUEPOINTS_CHANGED

      Fired when the cuepoints have changed.

      • A list of cuepoints can be seen as a time-schedule of adbreaks.

      • Only triggered for VOD streams.
      CONTENT_PAUSE_REQUESTED

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

      • For IMA this event will indicate the start of an adbreak.
      CONTENT_RESUME_REQUESTED

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

      • For IMA this event will indicate the end of an adbreak.
      FIRST_QUARTILE

      Fired when the ad has completed playing the first quartile (25%).
      LOG

      Fired to enable the SDK to communicate a message to be logged, which is stored in adData.

      • A VPAID ad sends a LOG message.

      • A non-fatal playback error occurs. In this case the adData object will contain extra information.
      AD_BREAK_READY

      Fired when an adbreak is ready from VMAP or ad rule ads.

      • This will only fire if autoPlayAdBreaks has been set to false in ImaSdkSettings.

      • The adData object will contain an adBreakTime property. This property will represent the time at which the adbreak occurred. 0 for pre-rolls, -1 for post-rolls. For mid-rolls, content playhead time, in seconds.
      MIDPOINT

      Fired when the ad has completed playing the first half (50%).
      PAUSED

      Fired when an ad is paused.
      RESUMED

      Fired when an ad is resumed.
      SKIPPABLE_STATE_CHANGED

      Fired when an ad changes its skippable state. E.g. will trigger at a given point, if the ad is skippable after that particular point in time.
      SKIPPED

      Fired when an ad was skipped.
      STARTED

      Fired when an ad starts playing.
      TAPPED

      Fired when a non-clickthrough portion of a video ad is clicked.
      ICON_TAPPED

      Fired when the user has tapped an ad icon.

      • On mobile, this will navigate to the landing page.

      • On Android TV, this will present a modal dialog containing the VAST icon fallback image.
      ICON_FALLBACK_IMAGE_CLOSED

      Fired when the user has closed the icon fallback image dialog.

      • This event only fires for Connected TV devices.

      • This may be a good time to resume ad playback if the user is ready to continue playing the ad.
      THIRD_QUARTILE

      Fired when the ad has completed playing the third quarter (75%).
      LOADED

      Fired when the VAST response has been received.
      AD_PROGRESS

      Fired to inform of ad progress. Can be used by the publisher to display some sort of countdown timer.
      AD_BUFFERING

      Fired when playback stalls while the ad buffers.
      AD_BREAK_STARTED

      Fired when an adbreak in a stream starts. An adbreak can contain multiple ads.
      AD_BREAK_ENDED

      Fired when an adbreak in a stream ends.
      AD_PERIOD_STARTED

      Fired when an ad period in a stream starts.

      • This event will be fired even for ads that are being replayed or when seeking to the middle of an adbreak.
      AD_PERIOD_ENDED

      Fired when an ad period in a stream ends.
      AD_ERROR

      Fired when an ad error occurs.

    • Method Summary

      Modifier and Type Method Description
      String getName() Function to get the name (textual representation) of an IMA related event.
      final GoogleImaAdEventType valueOf(String value) Returns the enum constant of this type with the specified name.
      final Array<GoogleImaAdEventType> values() Returns an array containing the constants of this enum type, in the order they're declared.
      final EnumEntries<GoogleImaAdEventType> getEntries() The event types of GoogleImaAdEvent.

      • Methods inherited from class kotlin.Enum

        getName, getOrdinal

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

    • Method Detail

      • getName

         String getName()

        Function to get the name (textual representation) of an IMA related event.

        Returns:

        The name of the event (NonNull).

      • valueOf

         final GoogleImaAdEventType 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<GoogleImaAdEventType> 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.