IMAAdsManager Class Reference

IMAAdsManager Class Reference

Overview

The IMAAdsManager class is responsible for playing ads.

Inherits NSObject.

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) - 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< IMAAdPlaybackInfoadPlaybackInfo
 Groups various properties about the linear ad playback. More...
 
float volume
 Set and get the volume for the current ad. More...
 

Method Documentation

- (void) initializeWithAdsRenderingSettings: (IMAAdsRenderingSettings *)  adsRenderingSettings

Initializes and loads the ad.

Parameters
adsRenderingSettingsthe IMAAdsRenderingSettings. Pass in to influence ad rendering. Use nil to default to standard rendering.
- (instancetype) NS_UNAVAILABLE

:nodoc:

- (void) start

Starts advertisement playback.

- (void) pause

Pauses advertisement.

- (void) resume

Resumes the advertisement.

- (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.

Property Documentation

- (NSObject<IMAAdsManagerDelegate>*) delegate
readwritenonatomicweak

The IMAAdsManagerDelegate to notify with events during ad playback.

- (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.

- (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.

Send feedback about...

IMA Client-Side SDK for tvOS
Need help? Visit our support page.