com.mopub.mobileads

Class VastVideoConfig

java.lang.Object

com.mopub.mobileads.VastVideoConfig

All Implemented Interfaces:

java.io.Serializable

public class VastVideoConfig
extends java.lang.Object
implements java.io.Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
VastVideoConfig()

Method Summary

Methods

Modifier and Type	Method and Description
void	addAbsoluteTrackers(java.util.List<VastAbsoluteProgressTracker> absoluteTrackers) Add trackers for absolute tracking.
void	addClickTrackers(java.util.List<VastTracker> clickTrackers)
void	addCloseTrackers(java.util.List<VastTracker> closeTrackers)
void	addCompleteTrackers(java.util.List<VastTracker> completeTrackers)
void	addErrorTrackers(java.util.List<VastTracker> errorTrackers) Add trackers for errors.
void	addFractionalTrackers(java.util.List<VastFractionalProgressTracker> fractionalTrackers) Add trackers for percentage-based tracking.
void	addImpressionTrackers(java.util.List<VastTracker> impressionTrackers)
void	addPauseTrackers(java.util.List<VastTracker> pauseTrackers) Add trackers for when the video is paused.
void	addResumeTrackers(java.util.List<VastTracker> resumeTrackers) Add trackers for when the video is resumed.
void	addSkipTrackers(java.util.List<VastTracker> skipTrackers)
java.util.ArrayList<VastAbsoluteProgressTracker>	getAbsoluteTrackers()
java.lang.String	getClickThroughUrl()
java.util.List<VastTracker>	getClickTrackers()
java.util.List<VastTracker>	getCloseTrackers()
java.util.List<VastTracker>	getCompleteTrackers()
java.lang.String	getCustomCloseIconUrl()
java.lang.String	getCustomCtaText()
DeviceUtils.ForceOrientation	getCustomForceOrientation() Get custom force orientation
java.lang.String	getCustomSkipText()
java.lang.String	getDiskMediaFileUrl()
java.lang.String	getDspCreativeId()
java.util.List<VastTracker>	getErrorTrackers() Gets a list of error trackers.
java.util.ArrayList<VastFractionalProgressTracker>	getFractionalTrackers()
java.util.List<VastTracker>	getImpressionTrackers() Getters
java.lang.String	getNetworkMediaFileUrl()
java.util.List<VastTracker>	getPauseTrackers()
int	getRemainingProgressTrackerCount() Returns the number of untriggered progress trackers.
java.util.List<VastTracker>	getResumeTrackers()
java.lang.Integer	getSkipOffsetMillis(int videoDuration) Gets the skip offset in milliseconds.
java.lang.String	getSkipOffsetString() Gets the String specified in the VAST document regarding the skip offset.
java.util.List<VastTracker>	getSkipTrackers()
java.util.Map<java.lang.String,VastCompanionAdConfig>	getSocialActionsCompanionAds()
java.util.List<VastTracker>	getUntriggeredTrackersBefore(int currentPositionMillis, int videoLengthMillis) Returns untriggered VAST progress trackers with a progress before the provided position.
VastCompanionAdConfig	getVastCompanionAd(int orientation)
com.mopub.mobileads.VastIconConfig	getVastIconConfig()
VideoViewabilityTracker	getVideoViewabilityTracker()
void	handleClickForResult(android.app.Activity activity, int contentPlayHead, int requestCode) Called when the video is clicked.
void	handleClickWithoutResult(android.content.Context context, int contentPlayHead) Called when the video is clicked.
void	handleClose(android.content.Context context, int contentPlayHead) Called when the video is closed or skipped.
void	handleComplete(android.content.Context context, int contentPlayHead) Called when the video is played completely without skipping.
void	handleError(android.content.Context context, VastErrorCode errorCode, int contentPlayHead) Called when there is a problem with the video.
void	handleImpression(android.content.Context context, int contentPlayHead) Called when the video starts playing.
void	handlePause(android.content.Context context, int contentPlayHead) Called when the video is not finished and is paused.
void	handleResume(android.content.Context context, int contentPlayHead) Called when the video is not finished and is resumed from the middle of the video.
boolean	hasCompanionAd() Returns whether or not there is a companion ad set.
boolean	isCustomForceOrientationSet()
boolean	isRewardedVideo() Returns whether or not this is an unskippable rewarded video.
void	setClickThroughUrl(java.lang.String clickThroughUrl)
void	setCustomCloseIconUrl(java.lang.String customCloseIconUrl)
void	setCustomCtaText(java.lang.String customCtaText)
void	setCustomForceOrientation(DeviceUtils.ForceOrientation customForceOrientation)
void	setCustomSkipText(java.lang.String customSkipText)
void	setDiskMediaFileUrl(java.lang.String diskMediaFileUrl)
void	setDspCreativeId(java.lang.String dspCreativeId) Setters
void	setIsRewardedVideo(boolean isRewardedVideo)
void	setNetworkMediaFileUrl(java.lang.String networkMediaFileUrl)
void	setSkipOffset(java.lang.String skipOffset)
void	setSocialActionsCompanionAds(java.util.Map<java.lang.String,VastCompanionAdConfig> socialActionsCompanionAds)
void	setVastCompanionAd(VastCompanionAdConfig landscapeVastCompanionAdConfig, VastCompanionAdConfig portraitVastCompanionAdConfig)
void	setVastIconConfig(com.mopub.mobileads.VastIconConfig vastIconConfig)
void	setVideoViewabilityTracker(VideoViewabilityTracker videoViewabilityTracker)

Methods inherited from class java.lang.Object

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

Constructor Detail

VastVideoConfig

public VastVideoConfig()

Method Detail

setDspCreativeId

public void setDspCreativeId(java.lang.String dspCreativeId)

Setters

getDspCreativeId

public java.lang.String getDspCreativeId()

addImpressionTrackers

public void addImpressionTrackers(java.util.List<VastTracker> impressionTrackers)

addFractionalTrackers

public void addFractionalTrackers(java.util.List<VastFractionalProgressTracker> fractionalTrackers)

Add trackers for percentage-based tracking. This includes all quartile trackers and any "progress" events with other percentages.

addAbsoluteTrackers

public void addAbsoluteTrackers(java.util.List<VastAbsoluteProgressTracker> absoluteTrackers)

Add trackers for absolute tracking. This includes start trackers, which have an absolute threshold of 2 seconds.

addCompleteTrackers

public void addCompleteTrackers(java.util.List<VastTracker> completeTrackers)

addPauseTrackers

public void addPauseTrackers(java.util.List<VastTracker> pauseTrackers)

Add trackers for when the video is paused.

Parameters:

pauseTrackers - List of String URLs to hit

addResumeTrackers

public void addResumeTrackers(java.util.List<VastTracker> resumeTrackers)

Add trackers for when the video is resumed.

Parameters:

resumeTrackers - List of String URLs to hit

addCloseTrackers

public void addCloseTrackers(java.util.List<VastTracker> closeTrackers)

addSkipTrackers

public void addSkipTrackers(java.util.List<VastTracker> skipTrackers)

addClickTrackers

public void addClickTrackers(java.util.List<VastTracker> clickTrackers)

addErrorTrackers

public void addErrorTrackers(java.util.List<VastTracker> errorTrackers)

Add trackers for errors.

Parameters:

errorTrackers - A URL to hit when an error happens.

setClickThroughUrl

public void setClickThroughUrl(java.lang.String clickThroughUrl)

setNetworkMediaFileUrl

public void setNetworkMediaFileUrl(java.lang.String networkMediaFileUrl)

setDiskMediaFileUrl

public void setDiskMediaFileUrl(java.lang.String diskMediaFileUrl)

setVastCompanionAd

public void setVastCompanionAd(VastCompanionAdConfig landscapeVastCompanionAdConfig,
                      VastCompanionAdConfig portraitVastCompanionAdConfig)

setSocialActionsCompanionAds

public void setSocialActionsCompanionAds(java.util.Map<java.lang.String,VastCompanionAdConfig> socialActionsCompanionAds)

setVastIconConfig

public void setVastIconConfig(com.mopub.mobileads.VastIconConfig vastIconConfig)

setCustomCtaText

public void setCustomCtaText(java.lang.String customCtaText)

setCustomSkipText

public void setCustomSkipText(java.lang.String customSkipText)

setCustomCloseIconUrl

public void setCustomCloseIconUrl(java.lang.String customCloseIconUrl)

setCustomForceOrientation

public void setCustomForceOrientation(DeviceUtils.ForceOrientation customForceOrientation)

setSkipOffset

public void setSkipOffset(java.lang.String skipOffset)

setVideoViewabilityTracker

public void setVideoViewabilityTracker(VideoViewabilityTracker videoViewabilityTracker)

setIsRewardedVideo

public void setIsRewardedVideo(boolean isRewardedVideo)

getImpressionTrackers

public java.util.List<VastTracker> getImpressionTrackers()

Getters

getAbsoluteTrackers

public java.util.ArrayList<VastAbsoluteProgressTracker> getAbsoluteTrackers()

getFractionalTrackers

public java.util.ArrayList<VastFractionalProgressTracker> getFractionalTrackers()

getPauseTrackers

public java.util.List<VastTracker> getPauseTrackers()

getResumeTrackers

public java.util.List<VastTracker> getResumeTrackers()

getCompleteTrackers

public java.util.List<VastTracker> getCompleteTrackers()

getCloseTrackers

public java.util.List<VastTracker> getCloseTrackers()

getSkipTrackers

public java.util.List<VastTracker> getSkipTrackers()

getClickTrackers

public java.util.List<VastTracker> getClickTrackers()

getErrorTrackers

public java.util.List<VastTracker> getErrorTrackers()

Gets a list of error trackers.

Returns:

List of String URLs.

getClickThroughUrl

public java.lang.String getClickThroughUrl()

getNetworkMediaFileUrl

public java.lang.String getNetworkMediaFileUrl()

getDiskMediaFileUrl

public java.lang.String getDiskMediaFileUrl()

getVastCompanionAd

public VastCompanionAdConfig getVastCompanionAd(int orientation)

getSocialActionsCompanionAds

public java.util.Map<java.lang.String,VastCompanionAdConfig> getSocialActionsCompanionAds()

getVastIconConfig

public com.mopub.mobileads.VastIconConfig getVastIconConfig()

getCustomCtaText

public java.lang.String getCustomCtaText()

getCustomSkipText

public java.lang.String getCustomSkipText()

getCustomCloseIconUrl

public java.lang.String getCustomCloseIconUrl()

getVideoViewabilityTracker

public VideoViewabilityTracker getVideoViewabilityTracker()

isCustomForceOrientationSet

public boolean isCustomForceOrientationSet()

hasCompanionAd

public boolean hasCompanionAd()

Returns whether or not there is a companion ad set. There must be both a landscape and a portrait companion ad set for this to be true.

Returns:

true if both the landscape and portrait companion ads are set, false otherwise.

getCustomForceOrientation

public DeviceUtils.ForceOrientation getCustomForceOrientation()

Get custom force orientation

Returns:

ForceOrientation enum (default is FORCE_LANDSCAPE)

getSkipOffsetString

public java.lang.String getSkipOffsetString()

Gets the String specified in the VAST document regarding the skip offset. This should be in the form HH:MM:SS[.mmm] or n%. (e.g. 00:00:12, 00:00:12.345, 42%).

Returns:

String representation of the skip offset or null if not set.

isRewardedVideo

public boolean isRewardedVideo()

Returns whether or not this is an unskippable rewarded video.

Returns:

True if this is a rewarded video, false otherwise.

handleImpression

public void handleImpression(android.content.Context context,
                    int contentPlayHead)

Called when the video starts playing.

Parameters:

context - The context. Can be application or activity context.

contentPlayHead - Current video playback time.

handleClickForResult

public void handleClickForResult(android.app.Activity activity,
                        int contentPlayHead,
                        int requestCode)

Called when the video is clicked. Handles forwarding the user to the specified click through url, calling Activity.onActivityResult(int, int, Intent) when done.

Parameters:

activity - Used to call startActivityForResult with provided requestCode.

contentPlayHead - Current video playback time when clicked.

requestCode - Code that identifies what kind of activity request is going to be made.

handleClickWithoutResult

public void handleClickWithoutResult(android.content.Context context,
                            int contentPlayHead)

Called when the video is clicked. Handles forwarding the user to the specified click through url. Does not provide any feedback when opened activity is finished.

Parameters:

context - Used to call startActivity.

contentPlayHead - Current video playback time when clicked.

handleResume

public void handleResume(android.content.Context context,
                int contentPlayHead)

Called when the video is not finished and is resumed from the middle of the video.

Parameters:

context - The context. Can be application or activity context.

contentPlayHead - Current video playback time.

handlePause

public void handlePause(android.content.Context context,
               int contentPlayHead)

Called when the video is not finished and is paused.

Parameters:

context - The context. Can be application or activity context.

contentPlayHead - Current video playback time.

handleClose

public void handleClose(android.content.Context context,
               int contentPlayHead)

Called when the video is closed or skipped.

Parameters:

context - The context. Can be application or activity context.

contentPlayHead - Current video playback time.

handleComplete

public void handleComplete(android.content.Context context,
                  int contentPlayHead)

Called when the video is played completely without skipping.

Parameters:

context - The context. Can be application or activity context.

contentPlayHead - Current video playback time (should be duration of video).

handleError

public void handleError(android.content.Context context,
               VastErrorCode errorCode,
               int contentPlayHead)

Called when there is a problem with the video. Refer to the possible VastErrorCodes for a list of problems.

Parameters:

context - The context. Can be application or activity context.

contentPlayHead - Current video playback time.

getUntriggeredTrackersBefore

public java.util.List<VastTracker> getUntriggeredTrackersBefore(int currentPositionMillis,
                                                       int videoLengthMillis)

Returns untriggered VAST progress trackers with a progress before the provided position.

Parameters:

currentPositionMillis - the current video position in milliseconds.

videoLengthMillis - the total video length.

getRemainingProgressTrackerCount

public int getRemainingProgressTrackerCount()

Returns the number of untriggered progress trackers.

Returns:

Integer count >= 0 of the remaining progress trackers.

getSkipOffsetMillis

public java.lang.Integer getSkipOffsetMillis(int videoDuration)

Gets the skip offset in milliseconds. If the skip offset would be past the video duration, this returns the video duration. Returns null when the skip offset is not set or cannot be parsed.

Parameters:

videoDuration - Used to calculate percentage based offsets.

Returns:

The skip offset in milliseconds. Can return null.