ConvivaConfiguration
@available(*, deprecated, message: "This class will be removed with the next major release.")
@objc(THEOplayerConvivaConfiguration)
public class ConvivaConfiguration : NSObject, AnalyticsDescription, Codable
The configuration of the Conviva Integration.
-
The identifier of the Conviva integration.
Declaration
Swift
@objc public var integration: AnalyticsIntegration
-
The Conviva customer key.
Declaration
Swift
@objc public private(set) var customerKey: String { get }
-
The interval at which metrics are reported, in seconds.
Declaration
Swift
public private(set) var heartbeatInterval: Int? { get }
-
The URL of your Conviva gateway.
Declaration
Swift
@objc public private(set) var gatewayUrl: String? { get }
-
Specifies the Conviva metadata.
Declaration
Swift
@objc public private(set) var contentMetadata: ConvivaContentMetadata { get }
-
By default, the player will automatically create a Conviva session when playback is started and cleanup the session when playback reaches the end of the content. When this option is set to
true
, the player will NOT perform automatic session creation and cleanup. Instead, the session must be created manually using createSession and cleanupSession.Declaration
Swift
public private(set) var manualSessionControl: Bool? { get }
-
Conviva Configuration
Declaration
Swift
public init(customerKey: String, heartbeatInterval: Int? = nil, gatewayURL: String? = nil, contentMetadata: ConvivaContentMetadata, manualSessionControl: Bool? = false)
Parameters
customerKey
The Conviva customer key.
heartbeatInterval
The Conviva heartbeat interval, in seconds.
gatewayURL
The Conviva gateway URL.
contentMetadata
Specifies the Conviva metadata.
manualSessionControl
By default, the player will automatically create a Conviva session when playback is started and cleanup the session when playback reaches the end of the content. When this option is set to
true
, the player will NOT perform automatic session creation and cleanup. Instead, the session must be created manually using createSession and cleanupSession.