Advertisements

When you use the player in your iOS or tvOS applications, you can incorporate advertisements to monetize content and engage your viewers.

The Apple SDK supports IMA3-based Video Ad Serving Template (VAST) and Video Multiple Ad Playlist (VMAP) ad integrations. It also accommodates popular third-party software-building tools like Google's Interactive Media Ads (IMA) SDK. With these technologies, you can customize your viewer's ad experiences and manage ad schedules and breaks within the player.

For more information related to listening to ad events, managing media playback, and handling advertising errors, see the following pages:

• Listen for events
• Manage media playback
• Handle errors

Configure your ads

The next few sections cover the configuration required to work with Google's IMA SDK. You must provide a valid ad schedule so the IMA SDK can prepare and load your advertisements. The AdSchedule protocol represents an ad schedule, serving as the basis for the two types of ad schedules available, AdSheduleWaterfall and AdScheduleRemote.

AdScheduleWaterfall

The AdScheduleWaterfall structure implements the AdSchedule protocol. It provides a waterfall-like sequence of ad breaks. It also helps to specify pre-roll, mid-roll, and post-roll ad breaks for media content. You can use the following properties with this struct.

Properties

You can declare these properties using the AdBreak struct, which defines an ad break array consisting of ad tags and an optional offset. The instance properties for the AdBreak struct are listed in the following table.

Example with MediaExternal

You can create an AdScheduleWaterfall instance with pre-roll, mid-roll, and post-roll, where each AdBreak consists of one or more ad tag URLs (such as VAST) and an offset that indicates the time when the break should start. This example creates an ad schedule that consists of:

• A pre-roll break with a single ad (offset is ignored).
• A mid-roll break with three ads, starting 15 seconds into the playback.
• A post-roll break with a single ad (offset is ignored).

let preRollBreak = AdBreak(adTags: ["https://link.to.a.vast.file"])
let midRollBreak = AdBreak(
  adTags: ["https://link.to.a.vast.file", "https://link.to.a.vast.file"],
  offset: 15
)
let postRollBreak = AdBreak(adTags: ["https://link.to.a.vast.file"])

let adSchedule = AdScheduleWaterfall(
  preAdBreak: preRollBreak,
  midAdBreak: midRollBreak,
  postAdBreak: postRollBreak
)

// Add ads manually when using external media
let externalMedia = MediaExternal(
    mediaUrl: URL(string: "https://link.to.a.media.file")!,
    adSchedule: adSchedule
)

AdScheduleRemote

AdScheduleRemote is another structure that implements the AdSchedule protocol. It provides the remote VMAP URL pointing to an ad schedule resource. The remote ad schedule can be fetched and parsed to determine ad breaks for the media content. You can use the following properties with this struct.

Properties

Example with MediaExternal

You can create an AdScheduleRemote instance with a URL to an ad playlist such as VMAP. Make sure that the provided link points to a valid playlist file.

Example AdScheduleRemote

let mediaURL =  URL(string: "https://link.to.a.media.file")!
let adScheduleURL = AdScheduleRemote(url: "https://link.to.a.vmap.file")

// Add ads manually when using external media
let externalMedia = MediaExternal(url: mediaURL, adSchedule: adScheduleURL)