BitmovinPlayerCore
AdvertisingApi

Protocol

AdvertisingApi

Provides access to advertising functionality and ad schedule information. Accessible through the player’s ads property.

@objc(BMPAdvertisingApi) protocol AdvertisingApi

Topics

Instance Properties

var activeAd: Ad?
The currently active linear ad.
var activeAdBreak: AdBreak?
The currently active ad break, or nil when no ad break is active.
var schedule: [AdBreak]
Upcoming ad breaks, sorted by schedule time ascending.
presentationContext
The current UIKit presentation context used for advertising integrations. The value is nil until both an ad container and its hosting view controller have been registered.

Instance Methods

func register(adContainer: UIView)
Registers the container for displaying ads.
func schedule(adItem: AdItem)
Schedules an ad for playback for the active source.
func skip()
Skips or dismisses the current ad when allowed. A successful linear-ad skip is signaled via an AdSkippedEvent. An active pause ad is dismissed immediately and signaled via NonLinearAdSkippedEvent.
- registerAdContainerViewController:
Registers the view controller containing the ad container. The registered view controller and the view supplied through register(adContainer:) form the current AdvertisingPresentationContext.