Properties | List of all members
IMAAdsRenderingSettings Class Reference

Set of properties that influence how ads are rendered. More...

#import <IMAAdsRenderingSettings.h>

+ Inheritance diagram for IMAAdsRenderingSettings:

Properties

NSArray * mimeTypes
 If specified, the SDK will play the media with MIME type on the list. More...
 
NSInteger bitrate
 Maximum recommended bitrate. More...
 
NSTimeInterval loadVideoTimeout
 Timeout (in seconds) when loading a video ad media file. More...
 
NSTimeInterval playAdsAfterTime
 For VMAP and ad rules playlists, only play ad breaks scheduled after this time (in seconds). More...
 
NSArray * uiElements
 Specifies the list of UI elements that should be visible. More...
 
BOOL disableUi
 Whether or not to disable ad UI for non TrueView ads. More...
 
UIViewController * webOpenerPresentingController
 Specifies the optional UIViewController that will be used to present an in-app browser. More...
 
id< IMAWebOpenerDelegate > webOpenerDelegate
 The IMAWebOpenerDelegate to be notified when in-app or external browser opens/closes. More...
 

Detailed Description

Set of properties that influence how ads are rendered.

Property Documentation

- (NSInteger) bitrate
readwritenonatomicassign

Maximum recommended bitrate.

The value is in kbit/s. SDK will pick media with bitrate below the specified max, or the closest bitrate if there is no media with smaller bitrate found. Default value, |kIMAAutodetectBitrate|, means the bitrate will be selected by the SDK, using the currently detected network speed (cellular or Wi-Fi).

- (BOOL) disableUi
readwritenonatomicassign

Whether or not to disable ad UI for non TrueView ads.

Check Ad.getDisableUi to check if this request was honored. Default is false. :nodoc:

- (NSTimeInterval) loadVideoTimeout
readwritenonatomicassign

Timeout (in seconds) when loading a video ad media file.

If loading takes longer than this timeout, the ad playback is canceled and the next ad in the pod plays, if available. Use -1 for the default of 8 seconds.

- (NSArray*) mimeTypes
readwritenonatomiccopy

If specified, the SDK will play the media with MIME type on the list.

List of strings specifying the MIME types. When nil or empty, the SDK will use it's default list of MIME types supported on iOS. Example: @[ "video/mp4", @"application/x-mpegURL" ] The property is an empty array by default.

- (NSTimeInterval) playAdsAfterTime
readwritenonatomicassign

For VMAP and ad rules playlists, only play ad breaks scheduled after this time (in seconds).

This setting is strictly after the specified time. For example, setting playAdsAfterTime to 15 will ignore an ad break scheduled to play at 15s.

- (NSArray*) uiElements
readwritenonatomiccopy

Specifies the list of UI elements that should be visible.

This property may be ignored for AdSense/AdX ads. For valid values, see IMAUiElementType.

- (id<IMAWebOpenerDelegate>) webOpenerDelegate
readwritenonatomicweak

The IMAWebOpenerDelegate to be notified when in-app or external browser opens/closes.

- (UIViewController*) webOpenerPresentingController
readwritenonatomicweak

Specifies the optional UIViewController that will be used to present an in-app browser.

When nil, tapping the video ad "Learn More" button or companion ads will result in opening Safari browser. If provided, in-app browser will be used, allowing the user to stay in the app and return easily.

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