SVSAdPlayerConfiguration

Objective-C

@interface SVSAdPlayerConfiguration : NSObject <NSCopying, NSCoding>

Swift

class SVSAdPlayerConfiguration : NSObject, NSCopying, NSCoding

Configuration of the ad player.

Configuration initialization

-init
Initialize a new instance of SVSAdPlayerConfiguration with the default configuration.
Declaration
Objective-C

- (nonnull instancetype)init;
Swift

init()
Return Value

The initialized SVSAdPlayerConfiguration instance.


                      
                      
                      -initWithJSON:

Initialize a new instance of SVSAdPlayerConfiguration from a JSON configuration.

Any configuration parameter not defined in this JSON will be initialized with its default value, any additional parameter not supported in the SDK will be ignored.

Declaration

Objective-C

- (nullable instancetype)initWithJSON:(nonnull NSString *)json;

Swift

convenience init?(json: String)

Parameters


                                  json

A string containing an ad player configuration JSON.

Return Value

The initialized SVSAdPlayerConfiguration instance, or nil if the JSON is invalid.


                      
                      
                      +adPlayerConfigurationFromURL:completionHandler:

Asynchronously retrieve a JSON based ad player configuration set from a given URL.

Any configuration parameter not defined in this JSON will be initialized with its default value, any additional parameter not supported in the SDK will be ignored.

Warning

The execution thread for the completion handler is not guaranteed. If you make UI modification in this handler, make sure to perform them on the main thread.

Declaration

Objective-C

+ (void)adPlayerConfigurationFromURL:(nonnull NSURL *)adPlayerConfigurationURL
                   completionHandler:
                       (nonnull void (^)(SVSAdPlayerConfiguration *_Nullable,
                                         NSError *_Nullable))completionHandler;

Swift

class func adPlayerConfiguration(from adPlayerConfigurationURL: URL) async throws -> SVSAdPlayerConfiguration

Parameters

`adPlayerConfigurationURL`	The URL of the JSON describing the ad player configuration.
`completionHandler`	The completion handler that will be called with the SVSAdPlayerConfiguration object.

Sub-configuration properties


                      
                      
                      displayOptions

Display configuration.

Declaration

Objective-C

@property (nonatomic, readonly) SVSAdPlayerConfigurationDisplayOptions *_Nonnull displayOptions;

Swift

var displayOptions: SVSAdPlayerConfigurationDisplayOptions { get }


                      
                      
                      publisherOptions

Publisher options.

Declaration

Objective-C

@property (nonatomic, readonly) SVSAdPlayerConfigurationPublisherOptions *_Nonnull publisherOptions;

Swift

var publisherOptions: SVSAdPlayerConfigurationPublisherOptions { get }


                      
                      
                      RTBOptions

RTB options.

Declaration

Objective-C

@property (nonatomic, readonly) SVSAdPlayerConfigurationRTBOptions *_Nonnull RTBOptions;

Swift

var rtbOptions: SVSAdPlayerConfigurationRTBOptions { get }


                      
                      
                      VPAIDOptions

VPAID ads options.

Declaration

Objective-C

@property (nonatomic, strong) SVSAdPlayerConfigurationVPAIDOptions *_Nonnull VPAIDOptions;

Swift

var vpaidOptions: SVSAdPlayerConfigurationVPAIDOptions { get set }