Package com.ooyala.pulse
Interface PulseLiveAdBreak
-
public interface PulseLiveAdBreak
This is the interface for ad breaks owned by aPulseLiveSession
. An ad break is a collection of ads that are to be displayed in sequence. PulseLiveAdBreaks are part of the "live" API's, which are better suited for live/streaming video setups. For live breaks, the SDK will not notify the integration when to trigger ads, that responsibility is on the integration. This interface is used to request information regarding the ad break.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
PulseLiveAdBreak.AdListReadyCallback
A callback that will receive a list of ad objects when they have been prepared (third party VAST data has been loaded and parsed).
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description RequestSettings.AdBreakType
getAdBreakType()
Returns the ad break type.void
getAllLinearAds(PulseLiveAdBreak.AdListReadyCallback adListReadyCallback)
Get the playable ads in this ad break.int
getPlayableAdsRemaining()
Get the number of playable ads remaining in this ad break.int
getPlayableAdsTotal()
Get the total number of playable ads in this ad break.
-
-
-
Method Detail
-
getPlayableAdsRemaining
int getPlayableAdsRemaining()
Get the number of playable ads remaining in this ad break.- Returns:
- The number of ads remaining.
-
getPlayableAdsTotal
int getPlayableAdsTotal()
Get the total number of playable ads in this ad break.- Returns:
- The total number of playable ads.
-
getAllLinearAds
void getAllLinearAds(PulseLiveAdBreak.AdListReadyCallback adListReadyCallback)
Get the playable ads in this ad break.- Parameters:
adListReadyCallback
- APulseLiveAdBreak.AdListReadyCallback
that will receive a list of ad objects when they have been prepared (any third party VAST data has been loaded).
-
getAdBreakType
RequestSettings.AdBreakType getAdBreakType()
Returns the ad break type.- Returns:
RequestSettings.AdBreakType
The type of ad break (preroll/midroll/postroll).
-
-