SSAI

Server Side ad Insertion

THEOplayer Supports Yospace and Google DAI server side ad insertion. If you need to use Client Side Ad Insertion (CSAI), please consider checking its documentations here.

GoogleInteractiveMediaAds.framework

The following is the supportMatrix for the GoogleInteractiveMediaAds SDK versions that THEOplayer is linked against. Although using a different version might work, we advise to use the exact same version that THEOplayer is using to avoid any compatibility issues.

PlayerVersion playerSuiteVersion GoogleInteractiveMediaAds verions
2.84.0+ 2021.2.0+ iOS 3.14.1 - tvOS 4.4.1

  • The ServerSideAdInsertionConfiguration protocol which specifies information to play a stream with server-side-inserted ads.

    Remark

    To integrate with specific SSAI vendors, check the Server-Side Ad Insertion pre-integration API.
    See more

    Declaration

    Swift

    @objc(THEOplayerServerSideAdInsertionConfiguration)
public protocol ServerSideAdInsertionConfiguration

  • The SSAI integration identifier.

    See more

    Declaration

    Swift

    @objc(THEOplayerSSAIIntegrationId)
public enum SSAIIntegrationId : Int
    extension SSAIIntegrationId: Codable

  • API for the Yospace pre-integration.

    See more

    Declaration

    Swift

    @available(*, deprecated, message: "This type is no longer available and will be removed in a future version.")
public protocol Yospace : EventDispatcherProtocol

  • The configuration of the Yospace log level.

    See more

    Declaration

    Swift

    @available(*, deprecated, message: "This type is no longer available and will be removed in a future version.")
@objc(THEOplayerYospaceLogLevelConfiguration)
public class YospaceLogLevelConfiguration : NSObject, Codable

  • The ServerSideAdInsertionConfiguration for the Yospace integration.

    See more

    Declaration

    Swift

    @available(*, deprecated, message: "This type is no longer available and will be removed in a future version.")
@objc(THEOplayerYospaceServerSideAdInsertionConfiguration)
public class YospaceServerSideAdInsertionConfiguration : NSObject, ServerSideAdInsertionConfiguration, Codable

  • The Yospace event object.

    See more

    Declaration

    Swift

    @available(*, deprecated, message: "This type is no longer available and will be removed in a future version.")
@objc(THEOplayerYospaceEvent)
public class YospaceEvent : NSObject, EventProtocol

  • The YospaceEvent types.

    See more

    Declaration

    Swift

    @available(*, deprecated, message: "This type is no longer available and will be removed in a future version.")
public struct YospaceEventTypes

  • Fired when the Yospace.activeSession changes.

    Declaration

    Swift

    @available(*, deprecated, message: "This type is no longer available and will be removed in a future version.")
@objc(THEOplayerYospaceSessionChangedEvent)
public class YospaceSessionChangedEvent : YospaceEvent

  • The Google DAI configuration.

    See more

    Declaration

    Swift

    @objc(THEOplayerGoogleDAIConfiguration)
public class GoogleDAIConfiguration : NSObject, ServerSideAdInsertionConfiguration, Codable

  • Represents a configuration for server-side ad insertion with the Google DAI pre-integration for live streams.

    See more

    Declaration

    Swift

    @objc(THEOplayerGoogleDAILiveConfiguration)
public class GoogleDAILiveConfiguration : GoogleDAIConfiguration

  • A Google DAI typed source.

    See more

    Declaration

    Swift

    @objc(THEOplayerGoogleDAITypedSource)
public class GoogleDAITypedSource : TypedSource

  • Represents a configuration for server-side ad insertion with the Google DAI pre-integration for vod streams.

    See more

    Declaration

    Swift

    @objc(THEOplayerGoogleDAIVodConfiguration)
public class GoogleDAIVodConfiguration : GoogleDAIConfiguration

  • The enum for Stream type, can either be live or vod.

    See more

    Declaration

    Swift

    @objc(THEOplayerStreamType)
public enum StreamType : Int
    extension StreamType: Codable