SSAI Reference
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 | GoogleInteractiveMediaAds verions |
|---|---|
| 2.84.0+ | iOS 3.14.1 - tvOS 4.4.1 |
-
The ServerSideAdInsertionConfiguration protocol which specifies information to play a stream with server-side-inserted ads.
See moreRemark
To integrate with specific SSAI vendors, check the Server-Side Ad Insertion pre-integration API.Declaration
Swift
public protocol ServerSideAdInsertionConfiguration -
The SSAI integration identifier.
See moreDeclaration
Swift
public enum SSAIIntegrationId : Intextension SSAIIntegrationId: Codable -
The Google DAI configuration.
See moreDeclaration
Swift
public class GoogleDAIConfiguration : NSObject, ServerSideAdInsertionConfiguration, Codable -
Represents a configuration for server-side ad insertion with the Google DAI pre-integration for live streams.
See moreDeclaration
Swift
public class GoogleDAILiveConfiguration : GoogleDAIConfiguration -
A Google DAI typed source.
See moreDeclaration
Swift
public class GoogleDAITypedSource : TypedSource -
Represents a configuration for server-side ad insertion with the Google DAI pre-integration for vod streams.
See moreDeclaration
Swift
public class GoogleDAIVodConfiguration : GoogleDAIConfiguration -
The enum for Stream type, can either be live or vod.
See moreDeclaration
Swift
public enum StreamType : Intextension StreamType: Codable -
A controller to be used by your
See moreServerSideAdIntegrationHandlerto update the state of your custom server-side ad integration.Declaration
Swift
public protocol ServerSideAdIntegrationController -
A handler for a server-side ad integration.
You can implement one or more of these methods to hook into various parts of the player’s lifecycle and perform your integration-specific ad handling.
Use the
See moreServerSideAdIntegrationControllerprovided byAds.registerServerSideIntegrationto update the state of your integration.Declaration
Swift
public protocol ServerSideAdIntegrationHandler -
The configuration for a custom server-side ad insertion (SSAI) integration.
See moreDeclaration
Swift
public protocol CustomServerSideAdInsertionConfiguration : ServerSideAdInsertionConfiguration