Interface VideoAdEventsInterface

  • All Implemented Interfaces:

    
    public interface VideoAdEventsInterface
    
                        

    Interface for tracking video ad lifecycle events within OMID ad sessions.

    This interface provides event callbacks for video advertisement lifecycle management and playback events. It integrates with the OMID standard to ensure proper measurement and verification of video ad events for viewability tracking, completion tracking, and third-party verification purposes.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
    • Field Summary

      Fields 
      Modifier and Type Field Description
    • Constructor Summary

      Constructors 
      Constructor Description
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Method Summary

      Modifier and Type Method Description
      Unit nonSkippableVideoAdLoaded(Boolean isAutoPlay) Called when a non-skippable video ad has been successfully loaded.
      Unit skippableVideoAdLoaded(Float skipOffset, Boolean isAutoPlay) Called when a skippable video ad has been successfully loaded.
      Unit trackAdVideoEvent(VideoEvent videoEvent) Tracks a video ad event during playback.
      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • nonSkippableVideoAdLoaded

         Unit nonSkippableVideoAdLoaded(Boolean isAutoPlay)

        Called when a non-skippable video ad has been successfully loaded.

        This method should be invoked when a video ad that cannot be skipped has finished loading and is ready for playback.

        Parameters:
        isAutoPlay - Whether the video will automatically start playing without user interaction
      • skippableVideoAdLoaded

         Unit skippableVideoAdLoaded(Float skipOffset, Boolean isAutoPlay)

        Called when a skippable video ad has been successfully loaded.

        This method should be invoked when a video ad that can be skipped after a certain duration has finished loading and is ready for playback.

        Parameters:
        skipOffset - The duration in seconds after which the ad can be skipped
        isAutoPlay - Whether the video will automatically start playing without user interaction
      • trackAdVideoEvent

         Unit trackAdVideoEvent(VideoEvent videoEvent)

        Tracks a video ad event during playback.

        This method should be called to report various video playback events such as start, pause, resume, quartile progress, completion, etc. These events are crucial for video ad measurement and verification.

        Parameters:
        videoEvent - The VideoEvent representing the specific video playback event