SessionConfiguration

public protocol SessionConfiguration

Common configuration contract for MediaTailor session initialization.

Conform to this protocol by using QpSessionConfiguration (QuickPlay / server-side tracking) or DzSessionConfiguration (Datazoom-backed tracking).

  • Dynamically-configurable domain parameters for the session.

    Declaration

    Swift

    var playerParams: [String : String]? { get set }

  • Additional undocumented parameters for session initialization beyond player and ad parameters.

    Declaration

    Swift

    var originParams: [String : String]? { get }

  • MediaTailor includes the manifestParams as query parameters in the parent manifest and tracking URLs.

    Declaration

    Swift

    var manifestParams: [String : String]? { get }

  • MediaTailor support for overlay ads (enabled by default).

    Declaration

    Swift

    var overlayAvails: OverlayAvailsMode? { get }

  • Configures MediaTailor to skip ad personalization for live content at specified times relative to the live edge.

    Declaration

    Swift

    var availSuppression: [String : String]? { get }

  • Ad ID signaling dictionary, or nil if disabled.

    Declaration

    Swift

    var adSignaling: [String : String]? { get }

  • Optional custom User-Agent string for session initialization requests.

    Declaration

    Swift

    var userAgent: String? { get }
  • liveAdTrackingMode Default implementation

    The mode which controls how live client-side tracking requests are managed. Only used by the Datazoom (DZ) session path; the QP path ignores this value.

    Default Implementation

    Default live ad tracking mode. Only the DZ session path overrides this.

    Declaration

    Swift

    var liveAdTrackingMode: AdTrackingMode { get }

  • Internal routing mode — determines which session provider and player implementation to use.

    Declaration

    Swift

    var reportingMode: SessionReportingMode { get }

SessionConfiguration protocol

  • toRequestBody() Extension method

    Serializes session parameters to a JSON request body.

    Declaration

    Swift

    func toRequestBody() -> Data?