SpotXAdDescription
@available(*, deprecated, message: "This class will be removed with the next major release.")
@objc(THEOplayerSpotXAdDescription)
public class SpotXAdDescription : NSObject, _AdDescription, Codable
An AdDescription
object that will be added to the player when using the SpotX ad integration.
-
The ad Integration.
Declaration
Swift
public var integration: AdIntegration?
-
The ad Integration.
Declaration
Swift
@objc(integration) public var integration_Objc: AdIntegration { get set }
-
The identifier of the ad break requested from SpotX.
Declaration
Swift
@objc public var id: String
-
The maximum duration of the ad.
Declaration
Swift
@objc public var maximumAdDuration: String?
-
The IP address of the viewer.
Declaration
Swift
@objc public var ipAddress: String?
-
Determines if the ad break request should contain a cache buster.
Remark
A cache buster adds a query parameter ‘cb’ with a random value to circumvent caching mechanisms.Declaration
Swift
public var cacheBuster: Bool?
-
The app related data for the SpotX tag.
Declaration
Swift
@objc public var app: SpotXData?
-
The device related data for the SpotX tag.
Declaration
Swift
@objc public var device: SpotXData
-
The user related data for the SpotX tag.
Declaration
Swift
@objc public var user: SpotXData?
-
The custom data for the SpotX tag.
Declaration
Swift
@objc public var custom: SpotXData?
-
A record of query string parameters added to the SpotX ad break request.
Remarks
- Each entry contains the parameter name with associated value.
- For more information, see
SpotXQueryParameter
.
Declaration
Swift
public var queryParameters: [String : SpotXQueryParameter]?
-
Constructs a SpotXAdDescription.
Declaration
Swift
public init(id: String, maximumAdDuration: String? = nil, ipAddress: String? = nil, cacheBuster: Bool? = nil, app: SpotXData? = nil, device: SpotXData? = nil, user: SpotXData? = nil, custom: SpotXData? = nil, queryParameters: [String : SpotXQueryParameter]? = nil)
Parameters
id
The identifier of the ad break requested from SpotX.
maximumAdDuration
The maximum duration of the ad, defaults to nil.
ipAddress
The IP address of the viewer, defaults to nil.
cacheBuster
Determins if the ad break request should contain a cache buster, defaults to nil.
app
The app related data for the SpotX tag, defaults to nil.
device
The device related data for the SpotX tag, defaults to nil.
user
The user related data for the SpotX tag, defaults to nil.
custom
The custom data for the SpotX tag, defaults to nil.
queryParameters
A record of query string parameters added to the SpotX ad break request, defaults to nil.