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

ServerSideAdInsertionConfiguration
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


                    
                    
                    SSAIIntegrationId

The SSAI integration identifier.

Declaration

Swift

@objc(THEOplayerSSAIIntegrationId)
public enum SSAIIntegrationId : Int

extension SSAIIntegrationId: Codable

Yospace
API for the Yospace pre-integration.
See more
Declaration
Swift

public protocol Yospace : EventDispatcherProtocol


                    
                    
                    YospaceLogLevelConfiguration

The configuration of the Yospace log level.

Declaration

Swift

@objc(THEOplayerYospaceLogLevelConfiguration)
public class YospaceLogLevelConfiguration : NSObject, Codable


                    
                    
                    YospaceServerSideAdInsertionConfiguration

The ServerSideAdInsertionConfiguration for the Yospace integration.

Declaration

Swift

@objc(THEOplayerYospaceServerSideAdInsertionConfiguration)
public class YospaceServerSideAdInsertionConfiguration : NSObject, ServerSideAdInsertionConfiguration, Codable


                    
                    
                    YospaceEvent

The Yospace event object.

Declaration

Swift

@objc(THEOplayerYospaceEvent)
public class YospaceEvent : NSObject, EventProtocol

YospaceEventTypes
The YospaceEvent types.
See more
Declaration
Swift

public struct YospaceEventTypes


                    
                    
                    YospaceSessionChangedEvent

Fired when the Yospace.activeSession changes.

Declaration

Swift

@objc(THEOplayerYospaceSessionChangedEvent)
public class YospaceSessionChangedEvent : YospaceEvent


                    
                    
                    GoogleDAIConfiguration

The Google DAI configuration.

Declaration

Swift

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

GoogleDAILiveConfiguration
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


                    
                    
                    GoogleDAITypedSource

A Google DAI typed source.

Declaration

Swift

@objc(THEOplayerGoogleDAITypedSource)
public class GoogleDAITypedSource : TypedSource

GoogleDAIVodConfiguration
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


                    
                    
                    StreamType

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

Declaration

Swift

@objc(THEOplayerStreamType)
public enum StreamType : Int

extension StreamType: Codable