Package com.theoplayer.android.api.ads

Interface AdBreak

  • All Implemented Interfaces:
    
public interface AdBreak

    The AdBreak API represents an ad break in the VMAP specification or an ad pod in the VAST specification.

    • 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
      abstract List<Ad> getAds() The list of all the ads which will be played sequentially at the ad break's time offset.
      abstract int getMaxDuration() Indicates the duration of the ad break, in seconds.
      abstract double getMaxRemainingDuration() Indicates the remaining duration of the ad break, in seconds.
      abstract int getTimeOffset() The time offset at which content will be paused to play the ad break, in seconds.
      abstract AdIntegrationKind getIntegration() The type of ad integration.
      abstract String getCustomIntegration() The type of custom ad integration.
      Object getCustomData() The additional integration-specific data associated with this ad break.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

    • Method Detail

      • getAds

        @NonNull() abstract List<Ad> getAds()

        The list of all the ads which will be played sequentially at the ad break's time offset.

        Returns:

        List of Ads. (NonNull)

      • getMaxDuration

         abstract int getMaxDuration()

        Indicates the duration of the ad break, in seconds.

        • Ads are lazily loaded. This property becomes available when all ads are loaded.
        • If the maximum duration is not set, it will return -1.
        Returns:

        The duration of the ad break, in seconds.

      • getMaxRemainingDuration

         abstract double getMaxRemainingDuration()

        Indicates the remaining duration of the ad break, in seconds.

        • Ads are lazily loaded. This property becomes available when all ads are loaded.
        • This property also considers the already played content of the current linear ad.
        • This feature is not available in the Google IMA integration and will default to -1.
        Returns:

        The remaining duration of the ad break, in seconds.

      • getTimeOffset

         abstract int getTimeOffset()

        The time offset at which content will be paused to play the ad break, in seconds.

        Returns:

        The time offset, in seconds.

      • getCustomData

        @Nullable() Object getCustomData()

        The additional integration-specific data associated with this ad break.

        Returns:

        The additional data.