com.iab.omid.library.adsession.video

Class VastProperties

java.lang.Object

com.iab.omid.library.adsession.video.VastProperties

public final class VastProperties
extends java.lang.Object

This object is used to capture key VAST properties so this can be shared with all registered verification providers.

Created by Natasha Garner on 09/09/2017.

Method Summary

Modifier and Type	Method and Description
static VastProperties	createVastPropertiesForNonSkippableVideo(boolean isAutoPlay, Position position) This method enables the video player to create a new VAST properties instance for non-skippable video ad placement.
static VastProperties	createVastPropertiesForSkippableVideo(float skipOffset, boolean isAutoPlay, Position position) This method enables the video player to create a new VAST properties instance for skippable video ad placement.

Methods inherited from class java.lang.Object

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

Method Detail

createVastPropertiesForSkippableVideo

public static VastProperties createVastPropertiesForSkippableVideo(float skipOffset,
                                                                   boolean isAutoPlay,
                                                                   Position position)

This method enables the video player to create a new VAST properties instance for skippable video ad placement.

Parameters:

skipOffset - number of seconds before the skip button is presented

isAutoPlay - whether the video will auto-play content

position - of the video in relation to other content

Returns:

new instance of VAST properties

Throws:

java.lang.IllegalArgumentException - if the supplied Position is null.

createVastPropertiesForNonSkippableVideo

public static VastProperties createVastPropertiesForNonSkippableVideo(boolean isAutoPlay,
                                                                      Position position)

This method enables the video player to create a new VAST properties instance for non-skippable video ad placement.

Parameters:

isAutoPlay - whether the video will auto-play content

position - of the video in relation to other content

Returns:

new instance of VAST properties

Throws:

java.lang.IllegalArgumentException - if the supplied Position is null.