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.
-
-
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. -
-
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.
-
getIntegration
@NonNull() abstract AdIntegrationKind getIntegration()
- Returns:
The ad integration type. (NonNull)
-
-
-
-