Customize video player options on iOS
ANVideoPlayerSettings class lets the publisher app to customize some of the Ad Video Player UI/Controls.
Note
The customization is applied to all the Video ads served through Xandr SDK both Instream and Banner Video (Outstream).
| Property | Default Setting | Description | Ad Units supporting the Setting |
|---|---|---|---|
BOOL showClickThruControl |
true | Determines whether the ClickThrough Control is displayed. Setting it to false makes the entire video clickable. | Instream/Banner Video |
NSString *clickThruText |
"Learn More" | Customizes the text associated with the ClickThrough Control. | Instream/Banner Video |
BOOL showFullScreenControl (Banner Video Only) |
true | Controls the visibility of the fullscreen button. | Banner Video |
BOOL showTopBar |
true | Determines whether the top bar, containing ClickThrough and Skip controls, is displayed. | Instream/Banner Video |
BOOL showAdText |
true | Controls the visibility of the ad text next to the ClickThrough control. | Instream/Banner Video/Interstitial |
NSString *adText |
"Ad" | Customizes the ad text on the video player. | Instream/Banner Video/Interstitial |
BOOL showVolumeControl |
true | Controls the visibility of the mute/unmute control. | Instream/Banner Video |
ANInitialAudioSetting initalAudio |
Sound On (Instream Video), Sound Off ( Banner Video) | Sets the initial audio state. | Instream/Banner Video |
BOOL showSkip |
true | Controls the visibility of the Skip control. | Instream |
NSString *skipDescription |
"Skip in %%TIME%%s" | Customizes Skip Description. | Instream |
NSString *skipLabelName |
"Skip ad" | Customizes Skip Label. | Instream |
NSInteger *skipOffset |
"5 seconds" | Customizes Skip Offset. | Instream |
Example
// Show or Hide the ClickThrough control on the video player. Default is YES, setting it to NO will make the entire video clickable
[[ANVideoPlayerSettings sharedInstance] setShowClickThruControl:NO];
// Change the ClickThrough text on the video player
[[ANVideoPlayerSettings sharedInstance] setClickThruText:@"SampleText"];
// Show or hide fullscreen control on the player. This is applicable only for Banner Video
[[ANVideoPlayerSettings sharedInstance] setShowFullScreenControl:YES];
// Show or hide the top bar that has (ClickThrough & Skip control)
[[ANVideoPlayerSettings sharedInstance] setShowTopBar:YES];
// Show or hide the "Ad" text next to the ClickThrough control
[[ANVideoPlayerSettings sharedInstance] setShowAdText:YES];
[[ANVideoPlayerSettings sharedInstance] setAdText:@"Video Ad"];
// Show or hide the volume control on the player
[[ANVideoPlayerSettings sharedInstance] setShowVolumeControl:YES];
// Decide how the ad video sound starts initially (sound on or off). By default, Instream Video will have sound enabled, while Banner Video will have sound disabled
[[ANVideoPlayerSettings sharedInstance] setInitalAudio:Default];
[[ANVideoPlayerSettings sharedInstance] setInitalAudio:SoundOn];
[[ANVideoPlayerSettings sharedInstance] setInitalAudio:SoundOff];
// Show or hide the Skip control on the player
[[ANVideoPlayerSettings sharedInstance] setShowSkip:YES];
// Change the skip description on the video player
[[ANVideoPlayerSettings sharedInstance] setSkipDescription:@"Video Skip Demo"];
// Change the skip button text on the video player
[[ANVideoPlayerSettings sharedInstance] setSkipLabelName:@"Test"];
// Configure the skip offset on the video player
[[ANVideoPlayerSettings sharedInstance] setSkipOffset:2];