Instream SDK/com.smartadserver.android.instreamsdk.model.adplayerconfig/SVSAdPlayerConfigurationPublisherOptions

SVSAdPlayerConfigurationPublisherOptions

open class SVSAdPlayerConfigurationPublisherOptions : Parcelable, Serializable

This class holds the configuration options related to the publisher

Constructors

Link copied to clipboard
constructor()
Default constructor with default values
constructor(@NonNull json: String)
Constructor from a JSON

Properties

Link copied to clipboard
open val assetsColor: Int
The color of the image assets used by the ad player.
Link copied to clipboard
open var maximumNumberOfRedirects: Int
Maximum wrapper redirection depth.
Link copied to clipboard
open var numberOfPassbackAds: Int
Number of passback ads returned in by the Ad Server.
Link copied to clipboard
open var requestTimeout: Int
Time allowed for a single HTTP request (in milliseconds).
Link copied to clipboard
open var skipDelay: Int
Duration after which a linear ad can be skipped when forceSkipDelay is true (in milliseconds).
Link copied to clipboard
open var stallTimeout: Int
Time allowed for a stalled ad playback to resume until it exits in error (in milliseconds).
Link copied to clipboard
open var totalTimeout: Int
Total time allowed for an AdBreak request (in milliseconds).

Functions

Link copied to clipboard
open fun isEnableAdBreakAutoplay(): Boolean
Returns whether the ad break will autoplay or not
Link copied to clipboard
open fun isEnableClickThroughButton(): Boolean
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)
Link copied to clipboard
open fun isEnableSSAR(): Boolean
Returns whether if Server Side Ad Rules should be used with this configuration.
Link copied to clipboard
open fun isEnableUniversalAdIdControlPolicy(): Boolean
Returns whether universal ad id control policy should be applied
Link copied to clipboard
open fun isEnableVPAID(): Boolean
Returns whether VPAID creatives should be enabled.
Link copied to clipboard
open fun isForceSkipDelay(): Boolean
Returns whether the Skip Offset attribute from VAST ads should be ignored.
Link copied to clipboard
open fun isPauseMainContentUntilVASTIsLoaded(): Boolean
Returns true if the AdManager should pause the content player at exact Ad break time even if Ad break data are not loaded yet.
Link copied to clipboard
open fun isReplayAds(): Boolean
Returns whether if ads should be played again when the content video is rewound.
Link copied to clipboard
open fun setEnableAdBreakAutoplay(enableAdBreakAutoplay: Boolean)
Sets whether the ad break should be autoplayed or not.
Link copied to clipboard
open fun setEnableClickThroughButton(enable: Boolean)
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)
Link copied to clipboard
open fun setEnableSSAR(enableSSAR: Boolean)
Sets whether Server Side Ad Rules should be used with this configuration.
Link copied to clipboard
open fun setEnableUniversalAdIdControlPolicy(enableUniversalAdIdControlPolicy: Boolean)
Sets whether universal ad id control policy should be applied
Link copied to clipboard
open fun setEnableVPAID(enableVPAID: Boolean)
Sets whether VPAID creatives should be enabled.
Link copied to clipboard
open fun setForceSkipDelay(forceSkipDelay: Boolean)
Sets whether the Skip Offset attribute from VAST ads should be ignored.
Link copied to clipboard
open fun setPauseMainContentUntilVASTIsLoaded(pauseMainContentUntilVASTIsLoaded: Boolean)
Sets whether the AdManager should pause the content player at exact Ad break time even if Ad break data are not loaded yet.
Link copied to clipboard
open fun setReplayAds(replayAds: Boolean)
Sets whether if ads should be played again when the content video is rewound.