IMAAdsManager Class Reference

The IMAAdsManager class is responsible for playing ads. More...

#import <IMAAdsManager.h>

Inheritance diagram for IMAAdsManager:

Instance Methods
(void)	- initializeWithAdsRenderingSettings:
	Initializes and loads the ad. More...
(instancetype)	- NS_UNAVAILABLE
	:nodoc: More...
(void)	- start
	Starts advertisement playback. More...
(void)	- pause
	Pauses advertisement. More...
(void)	- resume
	Resumes the advertisement. More...
(void)	- skip
	Skips the advertisement if the ad is skippable and the skip offset has been reached. More...
(void)	- clicked
	Performs a clickthrough on the advertisement if the UI was successfully disabled via AdsRenderingSettings.disableUi. More...
(void)	- destroy
	Causes the ads manager to stop the ad and clean its internal state. More...
(void)	- discardAdBreak
	If an ad break is currently playing, discard it and resume content. More...

Properties
NSObject< IMAAdsManagerDelegate > *	delegate
	The IMAAdsManagerDelegate to notify with events during ad playback. More...
NSArray *	adCuePoints
	List of content time offsets at which ad breaks are scheduled. More...
id< IMAAdPlaybackInfo >	adPlaybackInfo
	Groups various properties about the linear ad playback. More...
float	volume
	Set and get the volume for the current ad. More...

Detailed Description

The IMAAdsManager class is responsible for playing ads.

Method Documentation

- (void) clicked

Performs a clickthrough on the advertisement if the UI was successfully disabled via AdsRenderingSettings.disableUi.

:nodoc:

- (void) destroy

Causes the ads manager to stop the ad and clean its internal state.

- (void) discardAdBreak

If an ad break is currently playing, discard it and resume content.

Otherwise, ignore the next scheduled ad break.

- (void) initializeWithAdsRenderingSettings:

(IMAAdsRenderingSettings *)

adsRenderingSettings

Initializes and loads the ad.

Parameters

adsRenderingSettings

the IMAAdsRenderingSettings. Pass in to influence ad rendering. Use nil to default to standard rendering.

- (instancetype) NS_UNAVAILABLE

:nodoc:

- (void) pause

Pauses advertisement.

- (void) resume

Resumes the advertisement.

- (void) skip

Skips the advertisement if the ad is skippable and the skip offset has been reached.

- (void) start

Starts advertisement playback.

Property Documentation

- (NSArray*) adCuePoints

readnonatomiccopy

List of content time offsets at which ad breaks are scheduled.

Array of NSNumber double values in seconds. Empty NSArray for single ads or if no ad breaks are scheduled.

- (id<IMAAdPlaybackInfo>) adPlaybackInfo

readnonatomicstrong

Groups various properties about the linear ad playback.

- (NSObject<IMAAdsManagerDelegate>*) delegate

readwritenonatomicweak

The IMAAdsManagerDelegate to notify with events during ad playback.

- (float) volume

readwritenonatomicassign

Set and get the volume for the current ad.

From 0 (muted) to 1 (loudest). This volume is relative to device volume, not absolute. Default value is 1.

---

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

• IMAAdsManager.h