public class APSVastAdBreak extends APSMediaEvent
An APSVASTAdBreak object defines an ad break for which the builder plugin will try to generate APSMediaUnits and insert them into the playlist.
| Modifier and Type | Class and Description |
|---|---|
static class |
APSVastAdBreak.APSVASTConfigurationOptions |
APSMediaEvent.APSMediaEventState| Modifier and Type | Field and Description |
|---|---|
java.lang.String |
adOffset |
boolean |
allowMultipleAds |
static java.lang.String |
APSVastMidrollUnit |
static java.lang.String |
APSVastPostrollUnit |
static java.lang.String |
APSVastPrerollUnit |
static <any> |
CREATOR |
boolean |
followWrappers |
static java.lang.String |
kAPSMetadataCurrentAdBreakIndex |
static java.lang.String |
kAPSMetadataCurrentAdBreakOffset |
static java.lang.String |
kAPSMetadataTotalAdBreakAds |
java.util.HashMap<java.lang.String,java.lang.Object> |
metadata |
static java.lang.String |
METADATA_AD_ID |
static java.lang.String |
METADATA_AD_SEQUENCE |
static java.lang.String |
METADATA_AD_SERVING_ID |
static java.lang.String |
METADATA_AD_TYPE |
static java.lang.String |
METADATA_SKIPPABLE_AD |
static java.lang.String |
METADATA_SOURCE_INDEX |
static java.lang.String |
METADATA_SOURCE_URL |
static java.lang.String |
METADATA_UNIVERSAL_AD_ID |
static java.lang.String |
METADATA_UNIVERSAL_AD_REGISTRY |
static java.lang.String |
MIDCONTENT |
static java.lang.String |
NONLINEARS |
static java.lang.String |
POSTCONTENT |
static java.lang.String |
PRECONTENT |
APSVastAdBreak.APSVASTConfigurationOptions |
type |
dynamicPosition, loaded, preloadInterval, preloadPoint, repeatAfter, timeouttrackingURLs| Modifier | Constructor and Description |
|---|---|
|
APSVastAdBreak() |
protected |
APSVastAdBreak(Parcel in) |
| Modifier and Type | Method and Description |
|---|---|
void |
adBreakTrackErrorWithCodeEvent(APSVASTXMLNode adBreak,
int code,
java.lang.String ievent) |
int |
adCount() |
void |
addSource(APSVASTXMLNode node) |
void |
addSource(java.lang.String url) |
java.util.HashMap<java.lang.String,java.util.ArrayList<?>> |
adsForSourceFollowWrappersAllowMultipleAds(APSVASTXMLNode source,
boolean follow,
boolean allowMultipleAds,
int sourceIndex) |
boolean |
configureFromDictionary(java.util.Map<java.lang.String,java.lang.Object> adConfiguration) |
static APSVastAdBreak |
copyAdBreak(APSVastAdBreak defaultAdBreak) |
int |
describeContents() |
static java.util.ArrayList<APSVastAdBreak> |
generateAdBreaks(java.util.ArrayList<com.google.gson.internal.LinkedTreeMap<java.lang.String,java.lang.Object>> adBreakDictionariesArray,
APSVastAdBreak.APSVASTConfigurationOptions type,
APSVastAdBreak defaultAdBreak) |
APSVASTRootNode.APSAdPodFallback |
getAdPodFallbackStrategy() |
java.lang.String |
getBannerCloseButtonBackgroundColor() |
float |
getBannerCloseButtonFinalAlpha() |
Bitmap |
getBannerCloseButtonImage() |
float |
getBannerCloseButtonInitialAlpha() |
int |
getBannerCloseButtonOffsetX() |
int |
getBannerCloseButtonOffsetY() |
java.lang.String |
getBannerCloseButtonProgressColor() |
int |
getBannerCloseButtonSize() |
java.lang.String |
getBannerCloseButtonTrackColor() |
java.lang.String |
getBannerCloseButtonXColor() |
float |
getBannerFadeInDuration() |
int |
getBannerMaxSizeHeight() |
int |
getBannerMaxSizeWidth() |
APSMediaOverlay.APSMediaOverlayPosition |
getBannerPosition() |
int |
getBannerSkipOffset() |
androidx.collection.ArraySet<java.lang.String> |
getBlockedAdCategories() |
APSMediaUnit.APSMediaControlsDisplay |
getControlsDisplayForAds() |
java.util.HashMap<java.lang.String,java.lang.Object> |
getControlsParametersForAds() |
java.lang.String |
getCountdownColor() |
java.lang.String |
getCountdownFont() |
java.lang.String |
getCountdownHeight() |
APSMediaOverlay.APSMediaOverlayPosition |
getCountdownPosition() |
java.lang.String |
getCountdownSize() |
java.lang.String |
getCountdownText() |
java.lang.String |
getCountdownWidth() |
java.util.ArrayList<java.lang.String> |
getDefaultAdBreakPositions() |
int |
getDefaultBannerAdBreakDuration() |
float |
getDefaultIconHeightPercentage() |
int |
getDefaultSkipOffset() |
androidx.collection.ArraySet<java.lang.String> |
getDesiredAdCategories() |
float |
getIconFadeInDuration() |
APSMediaBuilder.APSResolvMultipleAdsConflictsBy |
getMultipleAdsConflictsPolicy() |
APSMediaOverlay.APSMediaOverlayPosition |
getNextMediaCountdownPosition() |
java.util.ArrayList<java.lang.String> |
getPrefferedVideoMimeTypes() |
java.lang.String |
getSkipButtonBackgroundColor() |
java.lang.String |
getSkipButtonBorderColor() |
int |
getSkipButtonBorderRadius() |
java.lang.String |
getSkipButtonHeight() |
int |
getSkipButtonPadding() |
APSMediaOverlay.APSMediaOverlayPosition |
getSkipButtonPosition() |
java.lang.String |
getSkipButtonProgressCircleColor() |
java.lang.String |
getSkipButtonProgressCircleTextColor() |
java.lang.String |
getSkipButtonProgressCircleTrackColor() |
APSMediaPlayerSkipOverlayController.APSSkipOverlayProgressPosition |
getSkipButtonProgressPosition() |
java.lang.String |
getSkipButtonText() |
java.lang.String |
getSkipButtonTextColor() |
java.lang.String |
getSkipButtonWidth() |
java.lang.String |
getTransactionId() |
java.lang.String |
getUserAgent() |
boolean |
isAllowMultipleAds() |
boolean |
isDebugMode() |
boolean |
isDynamicAdBreak() |
boolean |
isFollowWrappers() |
boolean |
isShowBannerCloseButton() |
boolean |
isShowCountdown() |
boolean |
isStretchBannersToMaxSize() |
void |
onPreload()
This method will be invoked on a different thread by the player,
before the event start point, as set by the preTriggerInterval field.
|
void |
onTrigger()
This code will be executed once the event is triggered by the player.
|
void |
onUnload()
This method will be invoked by the player once the event has reached
the end point and will be deallocated.
|
void |
onUpdate()
This method will be invoked by the player periodically, giving the event
the opportunity to respond to updated playback information.
|
static java.util.ArrayList<APSVastAdBreak> |
parseAdBreaksDictionary(com.google.gson.internal.LinkedTreeMap<java.lang.String,java.lang.Object> adBreaksDict,
APSVastAdBreak defaultAdBreak) |
void |
removeSource(APSVASTXMLNode node) |
void |
removeSource(java.lang.String url) |
java.util.List<APSMediaUnit> |
returnMediaUnits() |
void |
setAdPodFallbackStrategy(APSVASTRootNode.APSAdPodFallback adPodFallbackStrategy) |
void |
setAfterBannerTapped(APSMediaBuilder.APSWebviewDismissedAction afterBannerTapped) |
void |
setAfterVideoAdTapped(APSMediaBuilder.APSWebviewDismissedAction afterVideoAdTapped) |
void |
setBannerCloseButtonBackgroundColor(java.lang.String bannerCloseButtonBackgroundColor) |
void |
setBannerCloseButtonFinalAlpha(float bannerCloseButtonFinalAlpha) |
void |
setBannerCloseButtonImage(Bitmap bannerCloseButtonImage) |
void |
setBannerCloseButtonInitialAlpha(float bannerCloseButtonInitialAlpha) |
void |
setBannerCloseButtonOffsetX(int bannerCloseButtonOffsetX) |
void |
setBannerCloseButtonOffsetY(int bannerCloseButtonOffsetY) |
void |
setBannerCloseButtonProgressColor(java.lang.String bannerCloseButtonProgressColor) |
void |
setBannerCloseButtonSize(int bannerCloseButtonSize) |
void |
setBannerCloseButtonTrackColor(java.lang.String bannerCloseButtonTrackColor) |
void |
setBannerCloseButtonXColor(java.lang.String bannerCloseButtonXColor) |
void |
setBannerFadeInDuration(float bannerFadeInDuration) |
void |
setBannerMaxSizeHeight(int bannerMaxSizeHeight) |
void |
setBannerMaxSizeWidth(int bannerMaxSizeWidth) |
void |
setBannerPosition(APSMediaOverlay.APSMediaOverlayPosition bannerPosition) |
void |
setBannerSkipOffset(int bannerSkipOffset) |
void |
setControlsDisplayForAds(APSMediaUnit.APSMediaControlsDisplay controlsDisplayForAds) |
void |
setControlsParametersForAds(java.util.HashMap<java.lang.String,java.lang.Object> controlsParametersForAds) |
void |
setCountdownColor(java.lang.String countdownColor) |
void |
setCountdownFont(java.lang.String countdownFont) |
void |
setCountdownHeight(java.lang.String countdownHeight) |
void |
setCountdownPosition(APSMediaOverlay.APSMediaOverlayPosition countdownPosition) |
void |
setCountdownSize(java.lang.String countdownSize) |
void |
setCountdownText(java.lang.String countdownText) |
void |
setCountdownWidth(java.lang.String countdownWidth) |
void |
setDefaultAdBreakPositions(java.util.ArrayList<java.lang.String> defaultAdBreakPositions) |
void |
setDefaultBannerAdBreakDuration(int defaultBannerAdBreakDuration) |
void |
setDefaultIconHeightPercentage(float defaultIconHeightPercentage) |
void |
setDefaultSkipOffset(int defaultSkipOffset) |
void |
setDesiredAdCategories(java.util.ArrayList<java.lang.String> desiredAdCategories) |
void |
setIconFadeInDuration(float iconFadeInDuration) |
void |
setMultipleAdsConflictsPolicy(APSMediaBuilder.APSResolvMultipleAdsConflictsBy multipleAdsConflictsPolicy) |
void |
setNextMediaCountdownPosition(APSMediaOverlay.APSMediaOverlayPosition nextMediaCountdownPosition) |
boolean |
setPointsForOverlayForAdBreak(APSMediaOverlay overlay,
APSVASTXMLNode adBreak) |
void |
setPrefferedVideoMimeTypes(java.util.ArrayList<java.lang.String> prefferedVideoMimeTypes) |
void |
setShowBannerCloseButton(boolean showBannerCloseButton) |
void |
setShowCountdown(boolean showCountdown) |
void |
setSkipButtonBackgroundColor(java.lang.String skipButtonBackgroundColor) |
void |
setSkipButtonBorderColor(java.lang.String skipButtonBorderColor) |
void |
setSkipButtonBorderRadius(int skipButtonBorderRadius) |
void |
setSkipButtonHeight(java.lang.String skipButtonHeight) |
void |
setSkipButtonPadding(int skipButtonPadding) |
void |
setSkipButtonPosition(APSMediaOverlay.APSMediaOverlayPosition skipButtonPosition) |
void |
setSkipButtonProgressCircleColor(java.lang.String skipButtonProgressCircleColor) |
void |
setSkipButtonProgressCircleTextColor(java.lang.String skipButtonProgressCircleTextColor) |
void |
setSkipButtonProgressCircleTrackColor(java.lang.String skipButtonProgressCircleTrackColor) |
void |
setSkipButtonProgressPosition(APSMediaPlayerSkipOverlayController.APSSkipOverlayProgressPosition skipButtonProgressPosition) |
void |
setSkipButtonText(java.lang.String skipButtonText) |
void |
setSkipButtonTextColor(java.lang.String skipButtonTextColor) |
void |
setSkipButtonWidth(java.lang.String skipButtonWidth) |
void |
setStretchBannersToMaxSize(boolean stretchBannersToMaxSize) |
void |
writeToParcel(Parcel dest,
int flags) |
adjustForAbsoluteDuration, adjustRelativeToDuration, endPoint, getState, incrementStartAndEndPointsWithInterval, needsToBeAdjustedRelativeToDuration, preload, registerEventStateListener, registerTimeoutListener, setEndPoint, setStartPoint, startPoint, trigger, unload, unregisterEventStateListener, unregisterEventTimeoutListener, updateStatepublic APSVastAdBreak.APSVASTConfigurationOptions type
public java.lang.String adOffset
public java.util.HashMap<java.lang.String,java.lang.Object> metadata
public static final java.lang.String PRECONTENT
public static final java.lang.String MIDCONTENT
public static final java.lang.String POSTCONTENT
public static final java.lang.String NONLINEARS
public static final java.lang.String METADATA_AD_TYPE
public static final java.lang.String METADATA_SOURCE_INDEX
public static final java.lang.String METADATA_SOURCE_URL
public static final java.lang.String METADATA_AD_ID
public static final java.lang.String METADATA_UNIVERSAL_AD_ID
public static final java.lang.String METADATA_UNIVERSAL_AD_REGISTRY
public static final java.lang.String METADATA_AD_SERVING_ID
public static final java.lang.String METADATA_SKIPPABLE_AD
public static final java.lang.String METADATA_AD_SEQUENCE
public static final java.lang.String APSVastPrerollUnit
public static final java.lang.String APSVastPostrollUnit
public static final java.lang.String APSVastMidrollUnit
public static final java.lang.String kAPSMetadataCurrentAdBreakIndex
public static final java.lang.String kAPSMetadataTotalAdBreakAds
public static final java.lang.String kAPSMetadataCurrentAdBreakOffset
public boolean allowMultipleAds
public boolean followWrappers
public static final <any> CREATOR
public APSVastAdBreak()
protected APSVastAdBreak(Parcel in)
public static APSVastAdBreak copyAdBreak(APSVastAdBreak defaultAdBreak)
public static java.util.ArrayList<APSVastAdBreak> parseAdBreaksDictionary(com.google.gson.internal.LinkedTreeMap<java.lang.String,java.lang.Object> adBreaksDict, APSVastAdBreak defaultAdBreak)
public static java.util.ArrayList<APSVastAdBreak> generateAdBreaks(java.util.ArrayList<com.google.gson.internal.LinkedTreeMap<java.lang.String,java.lang.Object>> adBreakDictionariesArray, APSVastAdBreak.APSVASTConfigurationOptions type, APSVastAdBreak defaultAdBreak)
public java.util.List<APSMediaUnit> returnMediaUnits()
public void onPreload()
APSMediaEventonPreload in class APSMediaEventpublic void onTrigger()
APSMediaEventonTrigger in class APSMediaEventpublic void onUnload()
APSMediaEventonUnload in class APSMediaEventpublic void onUpdate()
APSMediaEventonUpdate in class APSMediaEventpublic boolean configureFromDictionary(java.util.Map<java.lang.String,java.lang.Object> adConfiguration)
public boolean setPointsForOverlayForAdBreak(APSMediaOverlay overlay, APSVASTXMLNode adBreak)
public void adBreakTrackErrorWithCodeEvent(APSVASTXMLNode adBreak, int code, java.lang.String ievent)
public java.util.HashMap<java.lang.String,java.util.ArrayList<?>> adsForSourceFollowWrappersAllowMultipleAds(APSVASTXMLNode source, boolean follow, boolean allowMultipleAds, int sourceIndex)
public void addSource(java.lang.String url)
public void addSource(APSVASTXMLNode node)
public void removeSource(java.lang.String url)
public void removeSource(APSVASTXMLNode node)
public int describeContents()
describeContents in class APSMediaEventpublic int adCount()
public java.lang.String getTransactionId()
public java.lang.String getCountdownWidth()
public void setCountdownWidth(java.lang.String countdownWidth)
public java.lang.String getCountdownHeight()
public void setCountdownHeight(java.lang.String countdownHeight)
public java.lang.String getCountdownText()
public void setCountdownText(java.lang.String countdownText)
public java.lang.String getCountdownFont()
public void setCountdownFont(java.lang.String countdownFont)
public java.lang.String getCountdownSize()
public void setCountdownSize(java.lang.String countdownSize)
public java.lang.String getCountdownColor()
public void setCountdownColor(java.lang.String countdownColor)
public void writeToParcel(Parcel dest,
int flags)
writeToParcel in class APSMediaEventpublic androidx.collection.ArraySet<java.lang.String> getDesiredAdCategories()
public void setDesiredAdCategories(java.util.ArrayList<java.lang.String> desiredAdCategories)
public androidx.collection.ArraySet<java.lang.String> getBlockedAdCategories()
public void setAfterVideoAdTapped(APSMediaBuilder.APSWebviewDismissedAction afterVideoAdTapped)
public void setAfterBannerTapped(APSMediaBuilder.APSWebviewDismissedAction afterBannerTapped)
public void setPrefferedVideoMimeTypes(java.util.ArrayList<java.lang.String> prefferedVideoMimeTypes)
public void setControlsDisplayForAds(APSMediaUnit.APSMediaControlsDisplay controlsDisplayForAds)
public void setControlsParametersForAds(java.util.HashMap<java.lang.String,java.lang.Object> controlsParametersForAds)
public void setMultipleAdsConflictsPolicy(APSMediaBuilder.APSResolvMultipleAdsConflictsBy multipleAdsConflictsPolicy)
public void setCountdownPosition(APSMediaOverlay.APSMediaOverlayPosition countdownPosition)
public void setSkipButtonPosition(APSMediaOverlay.APSMediaOverlayPosition skipButtonPosition)
public void setNextMediaCountdownPosition(APSMediaOverlay.APSMediaOverlayPosition nextMediaCountdownPosition)
public void setDefaultSkipOffset(int defaultSkipOffset)
public void setSkipButtonBorderRadius(int skipButtonBorderRadius)
public void setSkipButtonText(java.lang.String skipButtonText)
public void setSkipButtonTextColor(java.lang.String skipButtonTextColor)
public void setSkipButtonBorderColor(java.lang.String skipButtonBorderColor)
public void setSkipButtonBackgroundColor(java.lang.String skipButtonBackgroundColor)
public void setSkipButtonWidth(java.lang.String skipButtonWidth)
public void setSkipButtonHeight(java.lang.String skipButtonHeight)
public void setSkipButtonProgressCircleColor(java.lang.String skipButtonProgressCircleColor)
public void setSkipButtonProgressCircleTextColor(java.lang.String skipButtonProgressCircleTextColor)
public void setSkipButtonProgressCircleTrackColor(java.lang.String skipButtonProgressCircleTrackColor)
public void setSkipButtonProgressPosition(APSMediaPlayerSkipOverlayController.APSSkipOverlayProgressPosition skipButtonProgressPosition)
public void setAdPodFallbackStrategy(APSVASTRootNode.APSAdPodFallback adPodFallbackStrategy)
public void setDefaultAdBreakPositions(java.util.ArrayList<java.lang.String> defaultAdBreakPositions)
public void setDefaultBannerAdBreakDuration(int defaultBannerAdBreakDuration)
public void setBannerMaxSizeWidth(int bannerMaxSizeWidth)
public void setBannerMaxSizeHeight(int bannerMaxSizeHeight)
public void setDefaultIconHeightPercentage(float defaultIconHeightPercentage)
public void setIconFadeInDuration(float iconFadeInDuration)
public void setBannerFadeInDuration(float bannerFadeInDuration)
public void setShowCountdown(boolean showCountdown)
public void setStretchBannersToMaxSize(boolean stretchBannersToMaxSize)
public void setBannerSkipOffset(int bannerSkipOffset)
public void setSkipButtonPadding(int skipButtonPadding)
public void setBannerPosition(APSMediaOverlay.APSMediaOverlayPosition bannerPosition)
public void setShowBannerCloseButton(boolean showBannerCloseButton)
public void setBannerCloseButtonImage(Bitmap bannerCloseButtonImage)
public void setBannerCloseButtonBackgroundColor(java.lang.String bannerCloseButtonBackgroundColor)
public void setBannerCloseButtonXColor(java.lang.String bannerCloseButtonXColor)
public void setBannerCloseButtonInitialAlpha(float bannerCloseButtonInitialAlpha)
public void setBannerCloseButtonFinalAlpha(float bannerCloseButtonFinalAlpha)
public void setBannerCloseButtonSize(int bannerCloseButtonSize)
public void setBannerCloseButtonOffsetX(int bannerCloseButtonOffsetX)
public void setBannerCloseButtonOffsetY(int bannerCloseButtonOffsetY)
public void setBannerCloseButtonProgressColor(java.lang.String bannerCloseButtonProgressColor)
public void setBannerCloseButtonTrackColor(java.lang.String bannerCloseButtonTrackColor)
public java.util.ArrayList<java.lang.String> getPrefferedVideoMimeTypes()
public APSMediaUnit.APSMediaControlsDisplay getControlsDisplayForAds()
public java.util.HashMap<java.lang.String,java.lang.Object> getControlsParametersForAds()
public APSMediaBuilder.APSResolvMultipleAdsConflictsBy getMultipleAdsConflictsPolicy()
public APSMediaOverlay.APSMediaOverlayPosition getCountdownPosition()
public APSMediaOverlay.APSMediaOverlayPosition getSkipButtonPosition()
public APSMediaOverlay.APSMediaOverlayPosition getNextMediaCountdownPosition()
public int getDefaultSkipOffset()
public int getSkipButtonBorderRadius()
public java.lang.String getSkipButtonText()
public java.lang.String getSkipButtonTextColor()
public java.lang.String getSkipButtonBorderColor()
public java.lang.String getSkipButtonBackgroundColor()
public java.lang.String getSkipButtonWidth()
public java.lang.String getSkipButtonHeight()
public java.lang.String getSkipButtonProgressCircleColor()
public java.lang.String getSkipButtonProgressCircleTextColor()
public java.lang.String getSkipButtonProgressCircleTrackColor()
public APSMediaPlayerSkipOverlayController.APSSkipOverlayProgressPosition getSkipButtonProgressPosition()
public APSVASTRootNode.APSAdPodFallback getAdPodFallbackStrategy()
public java.util.ArrayList<java.lang.String> getDefaultAdBreakPositions()
public int getDefaultBannerAdBreakDuration()
public int getBannerMaxSizeWidth()
public int getBannerMaxSizeHeight()
public float getDefaultIconHeightPercentage()
public float getIconFadeInDuration()
public float getBannerFadeInDuration()
public boolean isShowCountdown()
public boolean isStretchBannersToMaxSize()
public int getBannerSkipOffset()
public int getSkipButtonPadding()
public APSMediaOverlay.APSMediaOverlayPosition getBannerPosition()
public boolean isShowBannerCloseButton()
public Bitmap getBannerCloseButtonImage()
public java.lang.String getBannerCloseButtonBackgroundColor()
public java.lang.String getBannerCloseButtonXColor()
public float getBannerCloseButtonInitialAlpha()
public float getBannerCloseButtonFinalAlpha()
public int getBannerCloseButtonSize()
public int getBannerCloseButtonOffsetX()
public int getBannerCloseButtonOffsetY()
public java.lang.String getBannerCloseButtonProgressColor()
public java.lang.String getBannerCloseButtonTrackColor()
public boolean isAllowMultipleAds()
public boolean isFollowWrappers()
public java.lang.String getUserAgent()
public boolean isDebugMode()
public boolean isDynamicAdBreak()