IMAAdDisplayContainer Class Reference

The IMAAdDisplayContainer is responsible for managing the ad container view and companion ad slots used for ad playback. More...

#import <IMAAdDisplayContainer.h>

+ Inheritance diagram for IMAAdDisplayContainer:

Instance Methods

(instancetype) - initWithAdContainer:companionSlots:
 Initializes IMAAdDisplayContainer for rendering the ad and displaying the ad UI. More...
 
(instancetype) - NS_UNAVAILABLE
 :nodoc: More...
 
(void) - registerVideoControlsOverlay:
 Registers your application's video playback controls that will overlay this container. More...
 
(void) - unregisterAllVideoControlsOverlays
 Unregisters all previously registered video controls overlays. More...
 

Properties

UIView * adContainer
 View containing the video display and ad related UI. More...
 
NSArray * companionSlots
 List of companion ad slots. More...
 

Detailed Description

The IMAAdDisplayContainer is responsible for managing the ad container view and companion ad slots used for ad playback.

Method Documentation

- (instancetype) initWithAdContainer: (UIView *)  adContainer
companionSlots: (NSArray *)  NS_DESIGNATED_INITIALIZER 

Initializes IMAAdDisplayContainer for rendering the ad and displaying the ad UI.

Parameters
adContainerthe UIView where the ad will be rendered. Fills the view's bounds
companionSlotsthe array of IMACompanionAdSlots. Can be nil or empty.
Returns
the IMAAdDisplayContainer instance
- (instancetype) NS_UNAVAILABLE

:nodoc:

- (void) registerVideoControlsOverlay: (UIView *)  videoControlsOverlay

Registers your application's video playback controls that will overlay this container.

Multiple controls may be registered with this method. WARNING: It is critical that this UI obscure as little ad space as possible so that viewabilty measurement isn't impacted.

Parameters
videoControlsOverlaySmall or mostly transparent video controls presented over the container.
- (void) unregisterAllVideoControlsOverlays

Unregisters all previously registered video controls overlays.

Property Documentation

- (UIView*) adContainer
readnonatomicstrong

View containing the video display and ad related UI.

This view must be present in the view hierarchy in order to make ad or stream requests.

- (NSArray*) companionSlots
readnonatomiccopy

List of companion ad slots.

Can be nil or empty.


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