Deprecating Media API in the Native SDKs

Product(s)
Video Cloud
Role(s)
Device SDK Developer
Task(s)
Manage Videos
Topic(s)
Playback
Type
Support Doc
SDK
Announcement
Android
iOS
tvOS

In this topic, you will learn how to migrate your apps from using the Media API to using the Playback API to retrieve your Video Cloud content.

Overview

The Media API is deprecated and will be end-of-life (EOL) as of December 31, 2017. It's replacement, the Playback API, is what you should use for returning video and playlist data from Video Cloud. Learn more in the Playback API Overview document.

The Playback API supports features not supported by the Media API, including the following:

  • WebVTT captions and subtitles
  • FairPlay Streaming content protection for iOS
  • Multiple manifest DASH video content
  • Dynamic Delivery of your video content
  • Many more, including future feature additions and enhancements

Am I using the Media API?

You are using the Media API if:

  • Your app uses a Media API READ token for authentication. The only way you can create or retieive one is through the Legacy Media API Management module in Video Cloud Studio. Your token will look similar to this:
    Legacy Media token
    Legacy Media token
  • Your app uses one of the following interfaces for retrieving video data:
    • Android: com.brightcove.player.media.catalog
    • iOS: BCOVCatalogService

Migrating to the Playback API

To migrate, change the API calls in your apps to use the Playback API instead of the Media API. Follow these steps:

  1. Use a Policy Key instead of the Media READ token.

    Authentication

    While the Media API uses a Media READ token for your account, the Playback API uses a Policy Key for authentication. Policy Keys are used to limit access based on account, IP address and/or geographic location.

    There are three ways you can obtain a Policy Key:

    • Every Brightcove web player is automatically assigned one. If you have a Brightcove player in your account, you can find instructions for getting a player's Policy Key. Since policy keys are valid account-wide, you can use it regardless of whether you are using this player.
    • You can generate a basic policy key using the Policy Keys Quick Start.
    • You can make a request to the Policy API.
  2. Change the API interface to use the Playback API as described in the tables below. Notice that the method names remain the same.

    API comparison tables

    Android

    API Interface method
    Playback API com.brightcove.player.edge.catalog findPlaylistByID
    findPlaylistByReferenceID
    findVideoByID
    findVideoByReferenceID
    Media API com.brightcove.player.media.catalog findPlaylistByID
    findPlaylistByReferenceID
    findVideoByID
    findVideoByReferenceID

    For a code sample that shows how to retrieve video and playlist data from the Playback API, see the Android: Working with Media Content document.

    iOS

    API Interface method
    Playback API BCOVPlaybackService findPlaylistByID
    findPlaylistByReferenceID
    findVideoByID
    findVideoByReferenceID
    Media API BCOVCatalogService findPlaylistByID
    findPlaylistByReferenceID
    findVideoByID
    findVideoByReferenceID

    For a code sample that shows how to retrieve video and playlist data from the Playback API, see the iOS: Working with Media Content document.