THEOAdDescription

public struct THEOAdDescription : AdDescription

Describes how TheoAds should be enabled

  • Declaration

    Swift

    public let integration: AdIntegration?

  • Default GAM network code to use for ad requests.

    This will be overridden by network codes parsed from THEOads ad cues. If no network code is configured, and it cannot be parsed from the THEOads ad cue, ads will not be loaded.

    Declaration

    Swift

    public let networkCode: String?

  • Default GAM custom asset key to use for ad requests.

    This will be overridden by custom asset keys parsed from THEOads ad cues. If no custom asset key is configured, and it cannot be parsed from the THEOads ad cue, ads will not be loaded.

    Declaration

    Swift

    public let customAssetKey: String?

  • Default backdrop image URL to be used as a background for ads with a double box layout.

    This will be overridden by backdrop image URLs parsed from THEOads ad cues. If no URL is configured, and it cannot be parsed from the THEOads ad cue, a black screen will be shown as background.

    Declaration

    Swift

    public let backdropDoubleBox: URL?

  • Default backdrop image URL to be used as a background for ads in L-shape layout.

    This will be overridden by backdrop image URIs parsed from THEOads ad cues. If no URI is configured, and it cannot be parsed from the THEOads ad cue, a black screen will be shown as background.

    Declaration

    Swift

    public let backdropLShape: URL?

  • Overrides the layout of all THEOads ad breaks, if set.

    Declaration

    Swift

    public let overrideLayout: LayoutOverride?

  • Overrides the ad source of all THEOads ad breaks, if set.

    • Only VOD streams are currently supported

    Declaration

    Swift

    public let overrideAdSrc: URL?

  • The ad tag parameters added to the GAM stream request.

    Declaration

    Swift

    public let adTagParameters: Dictionary<String, String>?

  • The streamActivityMonitorId added to the GAM Pod stream request.

    Declaration

    Swift

    public let streamActivityMonitorId: String?

  • Whether to use the ID3-based operating mode.

    • Only applicable for specific use-cases.

    Declaration

    Swift

    public let useId3: Bool

  • The endpoint from where to retrieve the server-sent events.

    Declaration

    Swift

    public let sseEndpoint: String?

  • The URI from where to retrieve the PodID’s as returned from the EABN service from Google.

    • Only applicable for specific use-cases.

    Declaration

    Swift

    public let retrievePodIdURI: String?

  • Declaration

    Swift

    public init(networkCode: String? = nil, customAssetKey: String? = nil, backdropDoubleBox: URL? = nil, backdropLShape: URL? = nil, overrideLayout: LayoutOverride? = nil, overrideAdSrc: URL? = nil, adTagParameters: Dictionary<String, String>? = nil, useId3: Bool? = nil, streamActivityMonitorId: String? = nil, sseEndpoint: String? = nil, retrievePodIdURI: String? = nil)

  • Describes how and when the layout of a THEOads ad break should be overridden.

    See more

    Declaration

    Swift

    public enum LayoutOverride