AdPlayer

public protocol AdPlayer : Player

Ad Player interface

  • Session Identifier for Active Ad Playback

    This property is available only after the playback state is .loaded and when using SSAI ad players.

    Note

    The value and availability depend on the current ad playback provider.

    Declaration

    Swift

    var adSessionId: String? { get }

  • API to invoke when the application received AVPlayerViewControllerDelegate callbacks for ads.

  • Undocumented

    Declaration

    Swift

    var adDelegate: AdPlayerDelegate? { get set }

  • ad type with player on seperate/Same player

    Declaration

    Swift

    var adInsertionType: AdInsertionType { get }

  • Open Measuremnt Delegate

    Declaration

    Swift

    var omEventDelegate: OpenMeasurementEventDelegate? { get set }

  • Skips the current ad (if skippable), else is a no-op.

    Declaration

    Swift

    func skipAd()

  • If an ad break is currently playing, discard it and resume content.

    Declaration

    Swift

    func discardAdBreak()

  • Returns an array of offsets in seconds indicating when a scheduled ad break will play. A preroll is represented by 0, and a postroll is represented by -1. An empty array indicates the ad or ad pod has no schedule and can be played at any time.

    Declaration

    Swift

    func getCuePoints() -> [Int]

  • Make sure to register before ad playback starts.

    Declaration

    Swift

    func registerFriendlyObstraction(adOverlayScope: [AdOverlayUIScope])

  • Unregister the obstraction after the playback finished.

    Declaration

    Swift

    func unregisterAllFriendlyObstractions()