SSAI

Server Side Ad Insertion

THEOplayer supports Google DAI, Yospace and Uplynk server side ad insertion. Google DAI requires the THEOplayer Google IMA Integration to be added to your project. For more information please refer here Yospace and Uplynk are supported through the iOS-Connector. If you need to use Client Side Ad Insertion (CSAI), please consider checking its own documentation here.

GoogleInteractiveMediaAds.xcframework

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

PlayerVersion	GoogleInteractiveMediaAds versions
11.X	iOS 3.31.0 - tvOS 4.16.0

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

public protocol ServerSideAdInsertionConfiguration


                    
                    
                    SSAIIntegrationId

The SSAI integration identifier.

Declaration

Swift

public enum SSAIIntegrationId : Int

extension SSAIIntegrationId: Codable


                    
                    
                    GoogleDAIConfiguration

The Google DAI configuration.

Declaration

Swift

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

public class GoogleDAILiveConfiguration : GoogleDAIConfiguration
GoogleDAITypedSource
A Google DAI typed source.
See more
Declaration
Swift

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

public class GoogleDAIVodConfiguration : GoogleDAIConfiguration
StreamType
The enum for Stream type, can either be live or vod.
See more
Declaration
Swift

public enum StreamType : Int

extension StreamType: Codable
ServerSideAdIntegrationController
A controller to be used by your ServerSideAdIntegrationHandler to update the state of your custom server-side ad integration.
See more
Declaration
Swift

public protocol ServerSideAdIntegrationController
ServerSideAdIntegrationHandler
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 ServerSideAdIntegrationController provided by Ads.registerServerSideIntegration to update the state of your integration.
See more
Declaration
Swift

public protocol ServerSideAdIntegrationHandler
CustomServerSideAdInsertionConfiguration
The configuration for a custom server-side ad insertion (SSAI) integration.
See more
Declaration
Swift

public protocol CustomServerSideAdInsertionConfiguration : ServerSideAdInsertionConfiguration