JWAdConfig
@interface JWAdConfig : NSObject
An object providing information about the way ads are handled by the player. Describes adMessage, skipMessage, skipText and skipOffset.
Note
In the current implementation, an adConfig object can be added to config and propagates to all adBreaks.-
The URL of the VAST tag to display, or the custom string of the Freewheel tag to display.
Note
can also specify Vast vmap file to use for ad breaks.Note
ignore if schedule is set.Declaration
Objective-C
@property (nonatomic, retain, readwrite, nullable) NSString *tag;
-
A message to be shown to the user in place of a seekbar while the ad is playing.
Note
‘xx’ in the message is replaced with countdown timer until the end of the ad.Declaration
Objective-C
@property (nonatomic, retain, readwrite, nullable) NSString *adMessage;
-
A message to be shown on the skip button during countdown to skip availablilty.
Note
‘xx’ in the message is replaced with countdown timer until the moment skip becomes available.See
skipTextDeclaration
Objective-C
@property (nonatomic, retain, readwrite, nullable) NSString *skipMessage;
-
A message to be shown on the skip button when the skip option becomes available.
Declaration
Objective-C
@property (nonatomic, retain, readwrite, nullable) NSString *skipText;
-
An integer representing the number of seconds before the ad can be skipped.
Declaration
Objective-C
@property (nonatomic, assign, unsafe_unretained, readwrite) NSUInteger skipOffset;
-
An array of JWAdBreak objects that proivides info about ad breaks.
Note
tag property is ignored if this property is not nil.See
JWAdBreakDeclaration
Objective-C
@property (nonatomic, retain, readwrite, nullable) NSArray<JWAdBreak *> *schedule;
-
Vast vmap file to use for ad breaks.
Note
schedule is ignored if this property is not nil.Declaration
Objective-C
@property (nonatomic, retain, readwrite, nullable) NSString *adVmap;
-
Set to JWAdClientGoogima if you wish to use google IMA; set to JWAdClientVast if not. Setting to nil defaults to vast.
Note
Due to the fact that Google IMA’s iOS SDK is still in Beta mode, we suggest using the vast plugin.Declaration
Objective-C
@property (nonatomic, assign, unsafe_unretained, readwrite) JWAdClient client;
-
The IMASettings class stores the Google IMA SDK settings.
Note
When setting a custom imaSetting, the default value of enableBackgroundPlayback is NO.Declaration
Objective-C
@property (nonatomic, assign, unsafe_unretained, readwrite, nullable) IMASettings *googimaSettings;
-
The JWGoogimaDaiConfig class stores the Google IMA DAI settings.
Declaration
Objective-C
@property (nonatomic, assign, unsafe_unretained, readwrite, nullable) JWGoogimaDaiConfig *googimaDaiSettings;
-
The JWFreewheelConfig class stores the Freewheel SDK settings.
Note
When setting Freewheel settings, the value of adClient should be set to JWAdClientFreewheel.Declaration
Objective-C
@property (nonatomic, assign, unsafe_unretained, readwrite, nullable) JWFreewheelConfig *freewheel;
-
For forcing controls to show for VPAID ads. Default is false.
Note
If the VPAID creative has built-in controls, showing the controls may be redundant.Declaration
Objective-C
@property (nonatomic, assign, unsafe_unretained, readwrite) BOOL vpaidControls;
-
Use to control the frequency of ad playback.
Note
Available only for the VAST adClient.Declaration
Objective-C
@property (nonatomic, retain, readwrite, nullable) JWAdRules *rules;