Ads API Reference

Ads

The Ads object helps you configure and control ads within THEOplayer.

Declaration

Swift

public protocol Ads : EventDispatcherProtocol

Ad

An Ad is an abstract object that represents a single ad, which is a creative in the VAST specification.

Remark

See LinearAd and NonLinearAd

Declaration

Swift

public protocol Ad


                    
                    
                    LinearAd

Represents a linear ad in the VAST specification. It extends the properties of the Ad object.

Declaration

Swift

public protocol LinearAd : Ad


                    
                    
                    MediaFile

Represents the metadata of a media file with ad content.

Remark

This metadata is retrieved from the VAST file.

Declaration

Swift

@objc(THEOplayerMediaFile)
public protocol MediaFile


                    
                    
                    NonLinearAd

Represents a non-linear ad in the VAST specification. It extends the properties of the Ad object.

Declaration

Swift

public protocol NonLinearAd : Ad


                    
                    
                    ScheduledAd

An ad that is scheduled to appear at a certain point.

Declaration

Swift

@available(*, deprecated, message: "With the next major version, `ScheduledAd` will de obsoleted.")
public protocol ScheduledAd


                    
                    
                    AdBreak

An AdBreak is an object that represents a collection of ads that are scheduled at a certain time.

Declaration

Swift

public protocol AdBreak


                    
                    
                    CompanionAd

Represents a companion ad which is displayed besides the player.

Remark

It doesn’t extend the properties of Ad.

Declaration

Swift

public protocol CompanionAd


                    
                    
                    AdType

The type of Ad specifying whether it will interrupt the content or not.

Declaration

Swift

@objc(THEOplayerAdType)
public class AdType : NSObject, Codable


                    
                    
                    AdIntegration

The integration of the ad break.

Declaration

Swift

@objc(THEOplayerAdIntegration)
public enum AdIntegration : Int

extension AdIntegration: Codable


                    
                    
                    AdIntegrationKind

The integration kind of the Ad.

Declaration

Swift

@objc(THEOplayerAdIntegrationKind)
public enum AdIntegrationKind : Int

extension AdIntegrationKind: Codable, CaseIterable


                    
                    
                    AdPreloadType

The type of ad Preload. This indicates in which manner the advertisements will be downloaded in advance.

Declaration

Swift

@available(*, deprecated, message: "This enumeration will be removed with the next major release.")
@objc(THEOplayerAdPreloadType)
public enum AdPreloadType : Int

extension AdPreloadType: Encodable


                    
                    
                    Omid

The Open Measurement Interface Definition API which can be used to configure the ad viewability measurements conforming to the OMID standards.

Declaration

Swift

@objc(THEOplayerOmid)
public protocol Omid


                    
                    
                    OmidFriendlyObstruction

Represents a friendly obstruction instance for OMID.

Declaration

Swift

@objc(THEOplayerOmidFriendlyObstruction)
public class OmidFriendlyObstruction : NSObject


                    
                    
                    OmidFriendlyObstructionPurpose

The list of purposes for which an obstruction would be registered as friendly.

Declaration

Swift

@objc(THEOplayerOmidFriendlyObstructionPurpose)
public enum OmidFriendlyObstructionPurpose : Int