Overview: Brightcove Player SDK for iOS

Product(s)
Video Cloud
Brightcove Player
Role(s)
Device SDK Developer
Task(s)
Develop with the Native SDKs
SDK
Overview
iOS

Welcome to the Player SDK for iOS developer documentation. Here you will find the information to create native apps for playing video content on iOS devices.

Documentation structure

At Brightcove, we strive to keep the documentation structured, clean and intuitive. As such, we leverage github READMEs for details on all our plugins and integrations. For your convenience, we've listed and linked to these plugins below.

Supported versions

The Native Player SDK for iOS offers support for the following versions of iOS:

Active support

Brightcove provides active support for the latest iOS SDK on the following iOS versions:

  • iOS 12
  • iOS 11.4.1
  • iOS 10.3.3

Passive support

Brightcove provides passive support for the following iOS versions:

  • iOS 9.3.5

Understanding support levels

Support is defined in terms of the [major version].[minor version].[patch version] of an OS (for example: iOS 11.4.1). In order to take advantage of the latest technology improvements from Apple, we offer two levels of support:

  • Active: Brightcove will test and fix bugs on these OS versions.
  • Passive: Brightcove will test on these OS versions, but bug fixes will be handled on a case by case basis.

Generally, Brightcove provides active support for the versions of the OS that are used by 80% of the user base, and passive support for other versions used by at least 5% of the user base.

Getting started

Before beginning development with the Player SDK for iOS there are a few concepts you should learn about:

  1. Media

    The current version of the Native Player SDK supports playing content from your Video Cloud account through the Playback API, or as remote assets with internet accessible URLs.

  2. Analytics

    With the Native Player SDK, Video Cloud customers automatically get robust analytics data reported in Video Cloud.

  3. Core SDK and Dependencies

    The Brightcove Player SDK for iOS and its plugins can be added to your project using the CocoaPods dependency manager. The podspecs for all of the Brightcove Player SDK components are hosted in the BrightcoveSpecs repository.

  4. Native SDK Reference

    To aid in your understanding of the SDK, you can find a detailed breakdown of the architecture in the Player SDK for iOS. Learn how critical components interact to handle the complexities of controlling the native video player. Player SDK for iOS installation, quick start and architecture

    Here, you'll also find the latest beta version of the SDK, if one exists.

  5. Native SDK Overview

    For a quick overview, learn how the Brightcove Player SDK components interact with the native iOS components. Player SDK for iOS overview

  6. Questions and Answers

    Join us in the SDK developer forum where SDK related questions are answered by Brightcove engineers and the community. Search for previously answered questions or post a new one. As a public group, you can gain access by providing your email address.

  7. Video Training

    View a series of training videos that walk you through the steps of building a Swift app in Xcode that plays a video from your Video Cloud library.

Download the SDK

The Brightcove Player SDK for iOS contains two installation packages:

  • A dynamic framework which supports the following:
    • iOS 9 and higher
    • tvOS 9.0 and higher

Get the latest version of the Brightcove Native SDK for iOS:

  Package
(Github Repo)
Podspec Reference Documentation Notes Samples
SDK Native SDK for iOS v6.3.8 BrightcoveSpecs SDK Reference Release Notes Sample Applications

or select this button:


 

To view the product updates for all of the Native SDKs and the associated plugins, see the Release Notes for the Brightcove Native SDKs document.

Integrations

The following table contains links to get plugins integrated with your SDK implementation. The plugins can be downloaded from their respective Github repos, and each repo contains a detailed README with instructions on how to setup the plugin.

The sample applications demonstrate the basic functionality of each plugin integrated with the SDK. These sample apps are a good way to learn about each plugin, and serve as a reference point when debugging.

Previous integration versions

Category Brightcove Plugin
(Github Repo)
Podspec Reference Documentation Sample Apps Supported Partner/Vendor Plugin
Advertising IMA plugin v6.3.8 [1] [2] Brightcove-Player-SDK-IMA IMA Reference Google IMA Samples Google IMA v3.7.0
FreeWheel plugin v6.3.8 Brightcove-Player-SDK-FW FreeWheel Reference FreeWheel Samples FreeWheel Ad Manager v6.22.0
Once UX plugin v6.3.8 Brightcove-Player-SDK-OUX Once UX Reference Once UX Sample None
Analytics Omniture plugin v6.3.8 Brightcove-Player-SDK-Omniture Omniture Reference Omniture Samples Adobe Video Heartbeat v2.0.1

Adobe Marketing Cloud v4.14.1

Combining plugins

With the Native SDK for iOS, the BCOVSessionProviders from each plugin are created and chained together. This chain is then used to create the BCOVPlaybackController . For details, see the Combining Plugins section of the SDK Reference.

Advertising

Here is additional information you may find helpful when working with the Advertising plugins.

IMA plugin

The placement of VAST ads is typically specified by a VMAP document. VAST describes an ad while VMAP describes the placement of ads in a video. For code details, see the BasicIMAPlayer iOS sample.

When working with IMA ads, it is best practice to check that your ads work outside of the SDK before implementing them. The following links will be helpful for this:

Samples

For samples and code snippets, see the following:

The following table contains links to code samples that are in addition to the samples associated with the integrations in the previous section.

Sample Application Description
Basic Sample Play videos from a Video Cloud playlist.
DRM with FairPlay Protect your content with FPS (FairPlay Streaming).
DVR Live [1] Run an HLS live stream.
Native Controls Use the iOS native player controls.
Player UI Customization Experiment with several different layouts for custom controls. The Brightcove PlayerUI controls provide AirPlay functionality out-of-the-box. If you want to implement AirPlay with your own controls, see the Custom Controls for AirPlay code snippet.
Sidecar Subtitles Sample Display captions for videos which include them in a separate file.
360° Video Play a 360° video, as long as the projection property is set. When the Video 360 button in the control bar is tapped, the video is displayed in VR Goggles mode with side-by-side images. For details, see the Using 360-Degree Videos with the Native SDKs document.
Offline Playback Download and play HLS videos, including those protected with FairPlay encryption. For an overview, see the Offline Playback with the Native SDKs document. For developer details, see the iOS App Developers Guide for Offline Playback.

Solution guides

The following table contains links to developer docs which will help you get started with your own app using the Brightcove Player SDK, and guide you through some of the features and functionality available.

Guide Description
Brightcove Player SDK for iOS Setup Learn the basics of working with the Brightcove Player SDK for iOS by walking you through the development of a simple video playback app using content from your own backend system.

Video Cloud customers will additionally retrieve and play a video from the Brightcove Catalog service.
Source Selection Learn about the default rendition selection process when playing a video.
Using Brightcove Analytics Video Cloud customers will learn how to set properties in Brightcove Analytics from your mobile app using the Brightcove SDK for iOS.
Using WebVTT Captions Learn how to configure WebVTT captions for HLS videos when using the Native SDK for iOS.