Ads API

  • Ads

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

    See more

    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
    See more

    Declaration

    Swift

    public protocol Ad

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

    See more

    Declaration

    Swift

    public protocol LinearAd : Ad

  • Represents the metadata of a media file with ad content.

    Remark

    This metadata is retrieved from the VAST file.
    See more

    Declaration

    Swift

    @objc(THEOplayerMediaFile)
public protocol MediaFile

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

    See more

    Declaration

    Swift

    public protocol NonLinearAd : Ad

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

    See more

    Declaration

    Swift

    public protocol ScheduledAd

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

    See more

    Declaration

    Swift

    public protocol AdBreak

  • Represents a companion ad which is displayed besides the player.

    Remark

    It doesn’t extend the properties of Ad.
    See more

    Declaration

    Swift

    public protocol CompanionAd

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

    See more

    Declaration

    Swift

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

  • The integration of the ad break.

    See more

    Declaration

    Swift

    @objc(THEOplayerAdIntegration)
public enum AdIntegration : Int
    extension AdIntegration: Codable

  • The integration kind of the Ad.

    See more

    Declaration

    Swift

    @objc(THEOplayerAdIntegrationKind)
public enum AdIntegrationKind : Int
    extension AdIntegrationKind: Codable, CaseIterable

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

    See more

    Declaration

    Swift

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

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

    See more

    Declaration

    Swift

    @objc(THEOplayerOmid)
public protocol Omid

  • Represents a friendly obstruction instance for OMID.

    See more

    Declaration

    Swift

    @objc(THEOplayerOmidFriendlyObstruction)
public class OmidFriendlyObstruction : NSObject

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

    See more

    Declaration

    Swift

    @objc(THEOplayerOmidFriendlyObstructionPurpose)
public enum OmidFriendlyObstructionPurpose : Int