Page Summary
-
IMAAVPlayerContentPlayhead is used for content tracking with AVPlayer.
-
IMAAVPlayerVideoDisplay implements the IMAVideoDisplay protocol for ad playback using the content player.
-
IMAAd is a data object representing a single ad.
-
IMAAdDisplayContainer manages the ad container view and companion ad slots.
-
IMAAdError surfaces errors during ad loading or playing.
Classes
The following classes are available globally.
-
An implementation of IMAContentPlayhead for AVPlayer. Use this class to provide content tracking if your content player of choice is an AVPlayer or its subclass.
Declaration
Swift
class IMAAVPlayerContentPlayhead : NSObject , IMAContentPlayheadObjective-C
@interface IMAAVPlayerContentPlayhead : NSObject < IMAContentPlayhead > -
An implementation of the IMAVideoDisplay protocol. This object is intended to be initialized with the content player, and will reuse the player for playing ads.
Declaration
Swift
class IMAAVPlayerVideoDisplay : NSObject , IMAVideoDisplayObjective-C
@interface IMAAVPlayerVideoDisplay : NSObject < IMAVideoDisplay > -
Data object representing a single ad.
Declaration
Swift
class IMAAd : NSObjectObjective-C
@interface IMAAd : NSObject -
The IMAAdDisplayContainer is responsible for managing the ad container view and companion ad slots used for ad playback.
Declaration
Swift
class IMAAdDisplayContainer : NSObjectObjective-C
@interface IMAAdDisplayContainer : NSObject
-
Surfaces an error that occurred during ad loading or playing.
Declaration
Swift
class IMAAdError : NSObjectObjective-C
@interface IMAAdError : NSObject
-
Simple data class used to transport ad playback information.
Declaration
Swift
class IMAAdEvent : NSObjectObjective-C
@interface IMAAdEvent : NSObject -
Simple data object containing podding metadata.
Declaration
Swift
class IMAAdPodInfo : NSObjectObjective-C
@interface IMAAdPodInfo : NSObject
-
Ad data that is returned when the ads loader loads the ad.
Declaration
Swift
class IMAAdsLoadedData : NSObjectObjective-C
@interface IMAAdsLoadedData : NSObject
-
Ad error data that is returned when the ads loader fails to load the ad.
Declaration
Swift
class IMAAdLoadingErrorData : NSObjectObjective-C
@interface IMAAdLoadingErrorData : NSObject
-
The IMAAdsLoader class allows the requesting of ads from the ad server. Use the delegate to receive the loaded ads or loading error in case of failure.
Declaration
Swift
class IMAAdsLoader : NSObjectObjective-C
@interface IMAAdsLoader : NSObject
-
The IMAAdsManager class is responsible for playing ads.
Declaration
Swift
class IMAAdsManager : NSObjectObjective-C
@interface IMAAdsManager : NSObject
-
Set of properties that influence how ads are rendered.
Declaration
Swift
class IMAAdsRenderingSettings : NSObjectObjective-C
@interface IMAAdsRenderingSettings : NSObject -
Data class describing the ad request.
Declaration
Swift
class IMAAdsRequest : NSObjectObjective-C
@interface IMAAdsRequest : NSObject -
An object that holds data corresponding to the companion ad.
Declaration
Swift
class IMACompanionAd : NSObjectObjective-C
@interface IMACompanionAd : NSObject
-
Ad slot for companion ads. The SDK will put a subview inside the provided UIView container. The companion will be matched to the width and height provided here. This class cannot be instantiated on tvOS, where companion ads are not available.
Declaration
Swift
class IMACompanionAdSlot : NSObjectObjective-C
@interface IMACompanionAdSlot : NSObject -
Data object representation of a cuepoint for a single ad break.
Declaration
Swift
class IMACuepoint : NSObjectObjective-C
@interface IMACuepoint : NSObject -
An obstruction that is marked as “friendly” for viewability measurement purposes.
Declaration
Swift
class IMAFriendlyObstruction : NSObjectObjective-C
@interface IMAFriendlyObstruction : NSObject -
Data object describing a live stream request.
Declaration
Swift
class IMALiveStreamRequest : IMAStreamRequestObjective-C
@interface IMALiveStreamRequest : IMAStreamRequest -
A proxy class that lets IMA SDK detect entering and exiting Picture-in-Picture.
To use the proxy, create an instance of
IMAPictureInPictureProxywith the Picture-in-Picture delegate as an argument. Set the Picture-in-Picture controller’s delegate to the proxy. For details, see Picture in Picture .Declaration
Swift
class IMAPictureInPictureProxy : NSProxy , AVPictureInPictureControllerDelegate , AVPlayerViewControllerDelegateObjective-C
@interface IMAPictureInPictureProxy : NSProxy < AVPictureInPictureControllerDelegate , AVPlayerViewControllerDelegate > -
Data object describing a stream request for a pod serving stream.
Declaration
Swift
class IMAPodStreamRequest : IMAStreamRequestObjective-C
@interface IMAPodStreamRequest : IMAStreamRequest -
Data object describing a stream request for a third party stitched server-side ad insertion pod serving VOD stream.
Declaration
Swift
class IMAPodVODStreamRequest : IMAStreamRequestObjective-C
@interface IMAPodVODStreamRequest : IMAStreamRequest -
Stores the signal data for Secure Signals. Stores signals for Publisher Collected Signals only.
Declaration
Swift
class IMASecureSignals : NSObjectObjective-C
@interface IMASecureSignals : NSObject -
The IMASettings class stores SDK wide settings.
Declaration
Swift
class IMASettings : NSObject , NSCopyingObjective-C
@interface IMASettings : NSObject < NSCopying >
-
The IMAStreamManager class is responsible for playing streams.
Declaration
Swift
class IMAStreamManager : NSObjectObjective-C
@interface IMAStreamManager : NSObject -
Data class describing the stream request.
Declaration
Swift
class IMAStreamRequest : NSObjectObjective-C
@interface IMAStreamRequest : NSObject -
Simple data object containing universal ad ID information.
Declaration
Swift
class IMAUniversalAdID : NSObjectObjective-C
@interface IMAUniversalAdID : NSObject -
Data object describing a VOD stream request.
Declaration
Swift
class IMAVODStreamRequest : IMAStreamRequestObjective-C
@interface IMAVODStreamRequest : IMAStreamRequest -
Represents the IMA SDK version number.
Declaration
Swift
class IMAVersion : NSObjectObjective-C
@interface IMAVersion : NSObject -
Verifies the minimum OS version IMA SDK supports is compatible with the minimum OS version of your app. If not compatible, your app fails to compile.
Declaration
Swift
class IMAVersionCheck : NSObjectObjective-C
@interface IMAVersionCheck : NSObject -
Data object describing a stream request for a Google video stitcher live serving stream.
Declaration
Swift
class IMAVideoStitcherLiveStreamRequest : IMAPodStreamRequestObjective-C
@interface IMAVideoStitcherLiveStreamRequest : IMAPodStreamRequest -
Data object describing a stream request for a Google video stitcher video on demand serving stream.
Declaration
Swift
class IMAVideoStitcherVODStreamRequest : IMAStreamRequestObjective-C
@interface IMAVideoStitcherVODStreamRequest : IMAStreamRequest
