Properties | List of all members
IMASettings Class Reference

The IMASettings class stores SDK wide settings. More...

#import <IMASettings.h>

+ Inheritance diagram for IMASettings:

Properties

NSString * ppid
 Publisher Provided Identification (PPID) sent with ads request. More...
 
NSString * language
 Language specification used for localization. More...
 
NSUInteger maxRedirects
 Specifies maximum number of redirects after which subsequent redirects will be denied, and the ad load aborted. More...
 
BOOL enableBackgroundPlayback
 Enable background audio playback for the SDK. More...
 
BOOL autoPlayAdBreaks
 Specifies whether to automatically play VMAP and ad rules ad breaks. More...
 
BOOL disableNowPlayingInfo
 Specifies whether to update the MPNowPlayingInfoCenter content with the title "Advertisement". More...
 
NSString * playerType
 The partner specified video player that is integrating with the SDK. More...
 
NSString * playerVersion
 The partner specified player version that is integrating with the SDK. More...
 
BOOL enableDebugMode
 Toggles debug mode which will output detailed log information to the console. More...
 

Detailed Description

The IMASettings class stores SDK wide settings.

Property Documentation

- (BOOL) autoPlayAdBreaks
readwritenonatomicassign

Specifies whether to automatically play VMAP and ad rules ad breaks.

The default value is YES.

- (BOOL) disableNowPlayingInfo
readwritenonatomicassign

Specifies whether to update the MPNowPlayingInfoCenter content with the title "Advertisement".

If disabled, MPNowPlayingInfoCenter is untouched. The default value is NO.

- (BOOL) enableBackgroundPlayback
readwritenonatomicassign

Enable background audio playback for the SDK.

The default value is NO.

- (BOOL) enableDebugMode
readwritenonatomicassign

Toggles debug mode which will output detailed log information to the console.

Debug mode should be disabled in Release and will display a watermark when enabled. The default value is NO.

- (NSString*) language
readwritenonatomiccopy

Language specification used for localization.

|Language| must be formatted as a canonicalized IETF BCP 47 language identifier such as would be returned by [NSLocale preferredLanguages]. Setting this property after it has been sent to the IMAAdsLoader will be ignored and a warning will be logged.

- (NSUInteger) maxRedirects
readwritenonatomicassign

Specifies maximum number of redirects after which subsequent redirects will be denied, and the ad load aborted.

The number of redirects directly affects latency and thus user experience. This applies to all VAST wrapper ads. If the number of redirects exceeds |maxRedirects|, the ad request will fail with error code 302. The default value is 4.

- (NSString*) playerType
readwritenonatomiccopy

The partner specified video player that is integrating with the SDK.

- (NSString*) playerVersion
readwritenonatomiccopy

The partner specified player version that is integrating with the SDK.

- (NSString*) ppid
readwritenonatomiccopy

Publisher Provided Identification (PPID) sent with ads request.

The documentation for this class was generated from the following file: