SVSAdPlayerConfigurationPublisherOptions
extends Objectimplements Parcelable Serializable
| java.lang.Object | |
| ↳ | com.smartadserver.android.instreamsdk.model.adplayerconfig.SVSAdPlayerConfigurationPublisherOptions |
Class Overview
This class holds the configuration options related to the publisher
Summary
|
[Expand]
Inherited Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
 From interface
android.os.Parcelable
| |||||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
SVSAdPlayerConfigurationPublisherOptions()
Default constructor with default values
| |||||||||||
|
SVSAdPlayerConfigurationPublisherOptions(String json)
Constructor from a JSON
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| int |
getMaximumNumberOfRedirects()
Returns the maximum wrapper redirection depth.
| ||||||||||
| int |
getNumberOfPassbackAds()
Returns the number of passback ads returned by the Ad Server.
| ||||||||||
| int |
getRequestTimeout()
Returns the time allowed for a single HTTP request (in milliseconds).
| ||||||||||
| int |
getSkipDelay()
Returns the duration in milliseconds after which a linear ad can be skipped when forceSkipDelay is true.
| ||||||||||
| int |
getTotalTimeout()
Returns the total time allowed for an AdBreak request (in milliseconds)
If the total timeout is reached before any ad is displayed, the AdBreak is cancelled and the content player is resumed.
| ||||||||||
| boolean |
isEnableAdBreakAutoplay()
Returns whether the ad break will autoplay or not
| ||||||||||
| boolean |
isEnableClickThroughButton()
Returns whether there is a click through button on top of the ad player layer (true)
of if the whole ad player layer is clickable (false)
| ||||||||||
| boolean |
isEnableSSAR()
Returns whether if Server Side Ad Rules should be used with this configuration.
| ||||||||||
| boolean |
isEnableUniversalAdIdControlPolicy()
Returns whether universal ad id control policy should be applied
| ||||||||||
| boolean |
isEnableVPAID()
Returns whether VPAID creatives should be enabled.
| ||||||||||
| boolean |
isForceSkipDelay()
Returns whether the Skip Offset attribute from VAST ads should be ignored.
| ||||||||||
| boolean |
isPauseMainContentUntilVASTIsLoaded()
Returns true if the AdManager should pause the content player at exact Ad break time even if Ad break data are not loaded yet.
| ||||||||||
| boolean |
isReplayAds()
Returns whether if ads should be played again when the content video is rewound.
| ||||||||||
| void |
setEnableAdBreakAutoplay(boolean enableAdBreakAutoplay)
Sets whether the ad break should be autoplayed or not.
| ||||||||||
| void |
setEnableClickThroughButton(boolean enable)
Sets whether there is a click through button on top of the ad player layer (true)
of if the whole ad player layer is clickable (false)
| ||||||||||
| void |
setEnableSSAR(boolean enableSSAR)
Sets whether Server Side Ad Rules should be used with this configuration.
| ||||||||||
| void |
setEnableUniversalAdIdControlPolicy(boolean enableUniversalAdIdControlPolicy)
Sets whether universal ad id control policy should be applied
| ||||||||||
| void |
setEnableVPAID(boolean enableVPAID)
Sets whether VPAID creatives should be enabled.
| ||||||||||
| void |
setForceSkipDelay(boolean forceSkipDelay)
Sets whether the Skip Offset attribute from VAST ads should be ignored.
| ||||||||||
| void |
setMaximumNumberOfRedirects(int maximumNumberOfRedirects)
Sets the maximum wrapper redirection depth.
| ||||||||||
| void |
setNumberOfPassbackAds(int numberOfPassbackAds)
Sets the number of passback ads returned by the Ad Server.
| ||||||||||
| void |
setPauseMainContentUntilVASTIsLoaded(boolean pauseMainContentUntilVASTIsLoaded)
Sets whether the AdManager should pause the content player at exact Ad break time even if Ad break data are not loaded yet.
| ||||||||||
| void |
setReplayAds(boolean replayAds)
Sets whether if ads should be played again when the content video is rewound.
| ||||||||||
| void |
setRequestTimeout(int requestTimeout)
Sets the time allowed for a single HTTP request (in milliseconds).
| ||||||||||
| void |
setSkipDelay(int skipDelay)
Sets the duration in milliseconds after which a linear ad can be skipped when forceSkipDelay is true.
| ||||||||||
| void |
setTotalTimeout(int totalTimeout)
Sets the total time allowed for an AdBreak request (in milliseconds)
If the total timeout is reached before any ad is displayed, the AdBreak is cancelled and the content player is resumed.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
java.lang.Object
| |||||||||||
|
From interface
android.os.Parcelable
| |||||||||||
Public Constructors
public SVSAdPlayerConfigurationPublisherOptions ()
Default constructor with default values
public SVSAdPlayerConfigurationPublisherOptions (String json)
Constructor from a JSON
Throws
| JSONException |
|---|
Public Methods
public int getMaximumNumberOfRedirects ()
Returns the maximum wrapper redirection depth. This depth limitation is important to ensure that there will be no wrapper loop
public int getNumberOfPassbackAds ()
Returns the number of passback ads returned by the Ad Server. Value of 0 will disable passback ads. A positive number will return a precise number of passback ads. Default value is -1, meaning the delivery engine will choose the best value for passback ads.
public int getRequestTimeout ()
Returns the time allowed for a single HTTP request (in milliseconds). This timeout should always be smaller than totalTimeout.
public int getSkipDelay ()
Returns the duration in milliseconds after which a linear ad can be skipped when forceSkipDelay is true. -1 means not skippable, 0 means skippable immediately
public int getTotalTimeout ()
Returns the total time allowed for an AdBreak request (in milliseconds) If the total timeout is reached before any ad is displayed, the AdBreak is cancelled and the content player is resumed.
public boolean isEnableAdBreakAutoplay ()
Returns whether the ad break will autoplay or not
public boolean isEnableClickThroughButton ()
Returns whether there is a click through button on top of the ad player layer (true) of if the whole ad player layer is clickable (false)
public boolean isEnableSSAR ()
Returns whether if Server Side Ad Rules should be used with this configuration.
public boolean isEnableUniversalAdIdControlPolicy ()
Returns whether universal ad id control policy should be applied
public boolean isEnableVPAID ()
Returns whether VPAID creatives should be enabled.
public boolean isForceSkipDelay ()
Returns whether the Skip Offset attribute from VAST ads should be ignored. If true, the skipDelay property from this class will be used instead.
public boolean isPauseMainContentUntilVASTIsLoaded ()
Returns true if the AdManager should pause the content player at exact Ad break time even if Ad break data are not loaded yet. if false, the AdManager will pause the content player only when the AdBreak is ready to be played
public boolean isReplayAds ()
Returns whether if ads should be played again when the content video is rewound.
public void setEnableAdBreakAutoplay (boolean enableAdBreakAutoplay)
Sets whether the ad break should be autoplayed or not.
If the autoplay is disabled (false), you will have to start the ad break manually using
SVSAdManager startAdBreak method.
public void setEnableClickThroughButton (boolean enable)
Sets whether there is a click through button on top of the ad player layer (true) of if the whole ad player layer is clickable (false)
public void setEnableSSAR (boolean enableSSAR)
Sets whether Server Side Ad Rules should be used with this configuration.
public void setEnableUniversalAdIdControlPolicy (boolean enableUniversalAdIdControlPolicy)
Sets whether universal ad id control policy should be applied
public void setEnableVPAID (boolean enableVPAID)
Sets whether VPAID creatives should be enabled.
public void setForceSkipDelay (boolean forceSkipDelay)
Sets whether the Skip Offset attribute from VAST ads should be ignored. If true, the skipDelay property from this class will be used instead.
public void setMaximumNumberOfRedirects (int maximumNumberOfRedirects)
Sets the maximum wrapper redirection depth. This depth limitation is important to ensure that there will be no wrapper loop
public void setNumberOfPassbackAds (int numberOfPassbackAds)
Sets the number of passback ads returned by the Ad Server. Value of 0 will disable passback ads. A positive number will return a precise number of passback ads. Default value is -1, meaning the delivery engine will choose the best value for passback ads.
public void setPauseMainContentUntilVASTIsLoaded (boolean pauseMainContentUntilVASTIsLoaded)
Sets whether the AdManager should pause the content player at exact Ad break time even if Ad break data are not loaded yet. if false, the AdManager will pause the content player only when the AdBreak is ready to be played
public void setReplayAds (boolean replayAds)
Sets whether if ads should be played again when the content video is rewound.
public void setRequestTimeout (int requestTimeout)
Sets the time allowed for a single HTTP request (in milliseconds). This timeout should always be smaller than totalTimeout.
public void setSkipDelay (int skipDelay)
Sets the duration in milliseconds after which a linear ad can be skipped when forceSkipDelay is true. -1 means not skippable, 0 means skippable immediately
public void setTotalTimeout (int totalTimeout)
Sets the total time allowed for an AdBreak request (in milliseconds) If the total timeout is reached before any ad is displayed, the AdBreak is cancelled and the content player is resumed.