SVSAdPlayerConfigurationPublisherOptions

Objective-C

@interface SVSAdPlayerConfigurationPublisherOptions : NSObject <NSCopying>

Swift

class SVSAdPlayerConfigurationPublisherOptions : NSObject, NSCopying

Hold the configuration options related to the publisher.

Initialization

  • Initialize a new instance of SVSAdPlayerConfigurationPublisherOptions with the default configuration.

    Declaration

    Objective-C

    - (nonnull instancetype)init;

    Swift

    init()

    Return Value

    The initialized SVSAdPlayerConfigurationPublisherOptions instance.

Configuration properties

  • Indicates it the Skip Offset attribute from VAST ads should be ignored. If YES, the skipDelay property from this class will be used instead.

    Default: NO

    Declaration

    Objective-C

    @property (nonatomic) BOOL forceSkipDelay;

    Swift

    var forceSkipDelay: Bool { get set }

  • Duration in seconds after which a linear ad can be skipped when forceSkipDelay is set to YES.

    Use -1 to make creatives not skippable. Use 0 to make creative skippable immediately. Use a positive value for actual delay.

    Default: -1

    Declaration

    Objective-C

    @property (nonatomic) NSTimeInterval skipDelay;

    Swift

    var skipDelay: TimeInterval { get set }

  • YES if the AdManager should pause the content player at exact Ad break time even if Ad break data are not loaded yet. When NO, the AdManager will pause the content player only when the AdBreak is ready to be played.

    Default: YES

    Declaration

    Objective-C

    @property (nonatomic) BOOL pauseMainContentUntilVASTIsLoaded;

    Swift

    var pauseMainContentUntilVASTIsLoaded: Bool { get set }

  • Total time allowed for an AdBreak request. If the total timeout is reached before any ad is displayed, the AdBreak is cancelled and the content player is resumed.

    Default: 8s

    Declaration

    Objective-C

    @property (nonatomic) NSTimeInterval totalTimeout;

    Swift

    var totalTimeout: TimeInterval { get set }

  • Time allowed for a single HTTP request. This timeout should always be smaller than totalTimeout.

    Default: 3s

    Declaration

    Objective-C

    @property (nonatomic) NSTimeInterval requestTimeout;

    Swift

    var requestTimeout: TimeInterval { get set }

  • Time allowed for stall. If the stall timeout is reached before the ad can resume, the AdBreak playback is cancelled and the content player is resumed.

    Default: 10s

    Declaration

    Objective-C

    @property (nonatomic) NSTimeInterval stallTimeout;

    Swift

    var stallTimeout: TimeInterval { get set }

  • Maximum wrapper redirection depth. This depth limitation is important to ensure that there will be no wrapper loop.

    Default: 5

    Declaration

    Objective-C

    @property (nonatomic) NSInteger maximumNumberOfRedirects;

    Swift

    var maximumNumberOfRedirects: Int { get set }

  • Number of passback ads returned in 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.

    Declaration

    Objective-C

    @property (nonatomic) NSInteger numberOfPassbackAds;

    Swift

    var numberOfPassbackAds: Int { get set }

  • YES if ads should be played again when the content video is rewinded.

    Default: YES

    Declaration

    Objective-C

    @property (nonatomic) BOOL replayAds;

    Swift

    var replayAds: Bool { get set }

  • YES if ad breaks should be played automatically.

    Default: YES

    Declaration

    Objective-C

    @property (nonatomic) BOOL enableAdBreakAutoplay;

    Swift

    var enableAdBreakAutoplay: Bool { get set }

  • YES if you prefer to use Server-Side Ad-Rules for number of Ad Instances during each Ad Break.

    Default: NO

    Declaration

    Objective-C

    @property (nonatomic) BOOL enableSSAR;

    Swift

    var enableSSAR: Bool { get set }

  • YES if you want to apply strict UniversalAdId control policy.

    When activated, the SDK will discard every creative with a null or “unknown” UniversalAdId identification and replace it with a passback when possible. Additionally, an ad identified with an UniversalAdId will not be displayed more than once in the same ad break and will be replaced by a passback when possible.

    Note

    This feature is only available since VAST 4.0. If activated, every ad response with an inferior VAST version will be discarded.

    Default: NO

    Declaration

    Objective-C

    @property (nonatomic) BOOL enableUniversalAdIdControlPolicy;

    Swift

    var enableUniversalAdIdControlPolicy: Bool { get set }

  • When NO, the whole ad player layer view is clickable. When YES, a clickthrough button will be displayed above the video layer.

    Default: NO

    Declaration

    Objective-C

    @property (nonatomic) BOOL enableClickThroughButton;

    Swift

    var enableClickThroughButton: Bool { get set }

  • YES to enable VPAID ads, NO to disable them.

    Default: YES

    Declaration

    Objective-C

    @property (nonatomic) BOOL enableVPAID;

    Swift

    var enableVPAID: Bool { get set }