Step-by-Step: Simple TV Video App using Swift

There are two ways to try out this sample:

Download the sample

Download the entire Xcode project for experimentation.

1. Clone or download the Native SDK for iOS samples to your local system.
2. Navigate to the Player/AppleTV/swift sample app.
3. Run the pod install command.
4. Open and run the newly created workspace.

For details, see the Running Sample Apps for the Native SDK for iOS/tvOS document.

Build the app by following the steps in this guide

Follow the steps below to get familiar with setting up an app project that uses the Brightcove Player SDK for tvOS. You can view the complete code for each of the following:

1. AppDelegate
2. ViewController

Import the Native SDK

Although the Brightcove Native Player SDK for iOS is written in Obj-C, we can simply import the framework modules into our Swift project.

1. Below the existing import directive, add the following to import the Brightcove Native Player SDK:

   import BrightcovePlayerSDK

Customize the project with your values

Add values to access your Video Cloud account.

1. Below the import directives, add your own values for the following:

   • Line 12: Defines your Brightcove Playback API Policy Key. This example plays a video returned from the Brightcove Playback API, which is the latest and recommended API to retrieve content from your Video Cloud library. If you are not familiar with Policy Keys, see the Policy API Overview.

   • Line 13: Defines your Video Cloud Account ID

   • Line 14: Defines your Video Cloud Video ID

   fileprivate struct playbackConfig {
     static let policyKey = "your policy key"
     static let accountID = "your account id"
     static let videoID = "your video id"
   }

Create a view variable

1. In the ViewController class, add a variable for the view.

   class ViewController: UIViewController {
     @IBOutlet weak var videoContainerView: UIView!

Create the playback service

1. Create a variable that defines the Brightcove playback service with your Account ID and Policy Key. This will be initialized the first time it is called.

   If you are new to swift, review the guide about Lazy Stored Properties.

   lazy var playbackService: BCOVPlaybackService = {
     return BCOVPlaybackService(accountId: playbackConfig.accountID, policyKey: playbackConfig.policyKey)
   }()

Create the playback controller

1. Create a variable that defines the Brightcove playback controller. This will be created the first time it is called.

   • Lines 28-30: set the delegate and turn on the auto-advance and autoplay features.

   lazy var playbackController: BCOVPlaybackController? = {
     guard let _playbackController = BCOVPlayerSDKManager.shared().createPlaybackController() else {
       return nil
     }
     _playbackController.delegate = self
     _playbackController.isAutoAdvance = true
     _playbackController.isAutoPlay = true
   
     return _playbackController
   }()

Define the player view

1. Create a function named createTVPlayerView as follows:

   • Lines 38-39: Define the player view so that the tab bar panels can present other view controllers.
   • Lines 42-44: Create the player view and add it to the video container view.
   • Line 47: Associate the player view with the playback controller.
   • Line 49: Adds the player view as a subview of the main view.
   • Line 51: Turn off auto-resizing mask.

   • Lines 52-57: Use Auto Layout to define dynamic contraints for the player view.

   lazy var playerView: BCOVTVPlayerView? = {
     // Set yourself as the presenting view controller
     // so that tab bar panels can present other view controllers
     let options = BCOVTVPlayerViewOptions()
     options.presentingViewController = self
   
     // Create and add to the video container view
     guard let _playerView = BCOVTVPlayerView(options: options) else {
       return nil
     }
   
     // Link the playback controller to the Player View
     _playerView.playbackController = playbackController
   
     videoContainerView.addSubview(_playerView)
   
     _playerView.translatesAutoresizingMaskIntoConstraints = false
     NSLayoutConstraint.activate([
       _playerView.topAnchor.constraint(equalTo: videoContainerView.topAnchor),
       _playerView.rightAnchor.constraint(equalTo: videoContainerView.rightAnchor),
       _playerView.leftAnchor.constraint(equalTo: videoContainerView.leftAnchor),
       _playerView.bottomAnchor.constraint(equalTo: videoContainerView.bottomAnchor)
     ])
   
     return _playerView
   }()

Create an init function

1. Create an initfunction as follows:
   • Line 64: Calls the super class implementation of the init() function.

   • Line 65: Optional: Sends your Video Cloud Account ID to analytics. This is only needed if you override the BCOVVideo class or do not use the Brightcove Playback service or catalog.

   required init?(coder aDecoder: NSCoder)
   {
     super.init(coder: aDecoder)
     playbackController?.analytics.account = playbackConfig.accountID;
   }

Process after loading the view

1. In the viewDidLoad method add the following:

   • Line 72: Calls the requestContentFromPlaybackService function, which we will define in the next step.

   override func viewDidLoad() {
     super.viewDidLoad()
     // Do any additional setup after loading the view, typically from a nib.
   
     requestContentFromPlaybackService()
   }

Request content from the Brightcove library

In order to play back video content, you will request a playlist from the catalog service

1. Create a function named requestContentFromPlaybackService as follows:

   • Lines 75-76: return a video object from the Playback API based on the given video id.
   • Line 80: adds the video to the playback controller.
   • Line 82: writes an error message if a playlist is not returned.

   private func requestContentFromPlaybackService() {
     playbackService.findVideo(withConfiguration: configuration, queryParameters: nil, completion: { [weak self] (video: BCOVVideo?, jsonResponse: [AnyHashable: Any]?, error: Error?) -> Void in
   
       if let _video = video {
         //  since "isAutoPlay" is true, setVideos will begin playing the content
         self?.playbackController?.setVideos([_video] as NSArray)
       } else {
         print("ViewController Debug - Error retrieving video: \(error?.localizedDescription ?? "unknown error")")
       }
     }
   }

Extend the playback controller

This allows your app to listen and respond to video playback events.

1. Extend the view controller to include the Brightcove playback controller delegate, and listen for playback events. If you are new to swift, review the guide about Extensions.

   // MARK: - BCOVPlaybackControllerDelegate
   extension ViewController: BCOVPlaybackControllerDelegate {
   
     func playbackController(_ controller: BCOVPlaybackController!, didAdvanceTo session: BCOVPlaybackSession!) {
       NSLog("ViewController Debug - Advanced to new session.")
     }
   
     func playbackController(_ controller: BCOVPlaybackController!, playbackSession session: BCOVPlaybackSession!, didReceive lifecycleEvent: BCOVPlaybackSessionLifecycleEvent!) {
       NSLog("Event: %@", lifecycleEvent.eventType)
     }
   }

The rest

1. Create functions to handle focus overrides for older versions of tvOS.

   // MARK: - UIFocusEnvironment overrides
   extension ViewController {
   
     // Focus Environment override for tvOS 9
     override var preferredFocusedView: UIView? {
         return playerView
     }
   
     // Focus Environment override for tvOS 10+
     override var preferredFocusEnvironments: [UIFocusEnvironment] {
         return (playerView != nil ? [ playerView! ] : [])
     }
   }

View the code

The View Controller is now complete. Here is the full code:

//
//  ViewController.swift
//  Simple-Video-Playback
//
//  Copyright © 2018 Brightcove. All rights reserved.
//

import UIKit
import BrightcovePlayerSDK

fileprivate struct playbackConfig {
  static let policyKey = "your policy key"
  static let accountID = "your account id"
  static let videoID = "your video id"
}

class ViewController: UIViewController {
  @IBOutlet weak var videoContainerView: UIView!

  lazy var playbackService: BCOVPlaybackService = {
      return BCOVPlaybackService(accountId: playbackConfig.accountID, policyKey: playbackConfig.policyKey)
  }()

  lazy var playbackController: BCOVPlaybackController? = {
      guard let _playbackController = BCOVPlayerSDKManager.shared().createPlaybackController() else {
        return nil
      }
      _playbackController.delegate = self
      _playbackController.isAutoAdvance = true
      _playbackController.isAutoPlay = true

      return _playbackController
  }()

  lazy var playerView: BCOVTVPlayerView? = {
    // Set yourself as the presenting view controller
    // so that tab bar panels can present other view controllers
    let options = BCOVTVPlayerViewOptions()
    options.presentingViewController = self

    // Create and add to the video container view
    guard let _playerView = BCOVTVPlayerView(options: options) else {
      return nil
    }

    // Link the playback controller to the Player View
    _playerView.playbackController = playbackController

    videoContainerView.addSubview(_playerView)

    _playerView.translatesAutoresizingMaskIntoConstraints = false
    NSLayoutConstraint.activate([
      _playerView.topAnchor.constraint(equalTo: videoContainerView.topAnchor),
      _playerView.rightAnchor.constraint(equalTo: videoContainerView.rightAnchor),
      _playerView.leftAnchor.constraint(equalTo: videoContainerView.leftAnchor),
      _playerView.bottomAnchor.constraint(equalTo: videoContainerView.bottomAnchor)
    ])

    return _playerView
  }()

  required init?(coder aDecoder: NSCoder)
  {
    super.init(coder: aDecoder)
    playbackController?.analytics.account = playbackConfig.accountID; // Optional
  }

  override func viewDidLoad() {
    super.viewDidLoad()
    // Do any additional setup after loading the view, typically from a nib.

    requestContentFromPlaybackService()
  }

  private func requestContentFromPlaybackService() {
    playbackService.findVideo(withConfiguration: configuration, queryParameters: nil, completion: { [weak self] (video: BCOVVideo?, jsonResponse: [AnyHashable: Any]?, error: Error?) -> Void in

      if let _video = video {
        //  since "isAutoPlay" is true, setVideos will begin playing the content
        self?.playbackController?.setVideos([_video] as NSArray)
      } else {
        print("ViewController Debug - Error retrieving video: \(error?.localizedDescription ?? "unknown error")")
      }
    }
  }
}

// MARK: - BCOVPlaybackControllerDelegate
extension ViewController: BCOVPlaybackControllerDelegate {

  func playbackController(_ controller: BCOVPlaybackController!, didAdvanceTo session: BCOVPlaybackSession!) {
    NSLog("ViewController Debug - Advanced to new session.")
  }

  func playbackController(_ controller: BCOVPlaybackController!, playbackSession session: BCOVPlaybackSession!, didReceive lifecycleEvent: BCOVPlaybackSessionLifecycleEvent!) {
    NSLog("Event: %@", lifecycleEvent.eventType)
  }
}

// MARK: - UIFocusEnvironment overrides
extension ViewController {

  // Focus Environment override for tvOS 9
  override var preferredFocusedView: UIView? {
    return playerView
  }

  // Focus Environment override for tvOS 10+
  override var preferredFocusEnvironments: [UIFocusEnvironment] {
    return (playerView != nil ? [ playerView! ] : [])
  }
}

fileprivate struct playbackConfig {
    static let accountID = "your account id"
}

//
//  ViewController.swift
//  Simple-Video-Playback
//
//  Copyright © 2018 Brightcove. All rights reserved.
//

import UIKit
import BrightcovePlayerSDK

fileprivate struct playbackConfig {
  static let accountID = "1752604059001"
}

class ViewController: UIViewController {
  @IBOutlet weak var videoContainerView: UIView!

  lazy var playbackController: BCOVPlaybackController? = {
    guard let _playbackController = BCOVPlayerSDKManager.shared().createPlaybackController() else {
      return nil
    }
    _playbackController.delegate = self
    _playbackController.isAutoAdvance = true
    _playbackController.isAutoPlay = true

    return _playbackController
  }()

  lazy var playerView: BCOVTVPlayerView? = {
    // Set yourself as the presenting view controller
    // so that tab bar panels can present other view controllers
    let options = BCOVTVPlayerViewOptions()
    options.presentingViewController = self

    // Create and add to the video container view
    guard let _playerView = BCOVTVPlayerView(options: options) else {
      return nil
    }

    // Link the playback controller to the Player View
    _playerView.playbackController = playbackController

    videoContainerView.addSubview(_playerView)

    _playerView.translatesAutoresizingMaskIntoConstraints = false
    NSLayoutConstraint.activate([
      _playerView.topAnchor.constraint(equalTo: videoContainerView.topAnchor),
      _playerView.rightAnchor.constraint(equalTo: videoContainerView.rightAnchor),
      _playerView.leftAnchor.constraint(equalTo: videoContainerView.leftAnchor),
      _playerView.bottomAnchor.constraint(equalTo: videoContainerView.bottomAnchor)
    ])

    return _playerView
  }()

  required init?(coder aDecoder: NSCoder)
  {
    super.init(coder: aDecoder)
    playbackController?.analytics.account = playbackConfig.accountID;
  }

  override func viewDidLoad() {
    super.viewDidLoad()
    // Do any additional setup after loading the view, typically from a nib.

    // create an array of videos
    var videoArray = [AnyObject]()
    videoArray = [videoWithURL(url: NSURL(string: "https://sdks.support.brightcove.com/assets/videos/hls/laughing_gull/laughing_gull.m3u8")!),
        videoWithURL(url: NSURL(string: "https://sdks.support.brightcove.com/assets/videos/hls/greatblueheron/greatblueheron.m3u8")!)]

    playbackController?.setVideos(videoArray as NSFastEnumeration);
  }

  func videoWithURL(url: NSURL) -> BCOVVideo {
    // set the delivery method for BCOVSources that belong to a video
    let source:BCOVSource = BCOVSource(url: url as URL?, deliveryMethod: kBCOVSourceDeliveryHLS, properties: nil)
    let video = BCOVVideo.init(source: source, cuePoints: BCOVCuePointCollection.init(array: []), properties: [NSObject:AnyObject]())
    return video!
  }
}

// MARK: - BCOVPlaybackControllerDelegate
extension ViewController: BCOVPlaybackControllerDelegate {

  func playbackController(_ controller: BCOVPlaybackController!, didAdvanceTo session: BCOVPlaybackSession!) {
    NSLog("ViewController Debug - Advanced to new session.")
  }

  func playbackController(_ controller: BCOVPlaybackController!, playbackSession session: BCOVPlaybackSession!, didReceive lifecycleEvent: BCOVPlaybackSessionLifecycleEvent!) {
    NSLog("Event: %@", lifecycleEvent.eventType)
  }
}

// MARK: - UIFocusEnvironment overrides
extension ViewController {

  // Focus Environment override for tvOS 9
  override var preferredFocusedView: UIView? {
    return playerView
  }

  // Focus Environment override for tvOS 10+
  override var preferredFocusEnvironments: [UIFocusEnvironment] {
    return (playerView != nil ? [ playerView! ] : [])
  }
}