bitmovin-player-ios-samples

This repository contains sample apps which are using the Bitmovin Player iOS SDK.

Table of Content

Available Sample Apps
Sample Apps Setup Instructions
How to integrate the Bitmovin Player iOS SDK
Development Notes
- Casting Requirements
Documentation & Release Notes
Support

Available Sample Apps

Basics

BasicPlayback: Shows how to set up the Bitmovin Player for basic playback of HLS or progressive streams.
BasicPlaybackTV: Shows how to set up the Bitmovin Player for basic playback of HLS or progressive streams in a tvOS application.
BasicMetadataHandling Shows how to set up and configure the Bitmovin Player for playback of content that contains metadata.

DRM

BasicDRMPlayback: Shows how to set up and configure the Bitmovin Player for playback of FairPlay Streaming protected content.

Offline Playback

BasicOfflinePlayback Shows how to set up the Bitmovin Player to download protected and unprotected content for offline playback.

Playback & Casting

BackgroundPlayback Shows how to set up the Bitmovin Player for background playback (e.g. to play audio in silent mode).
BasicCasting Shows how to set up and configure Google ChromeCast support with the Bitmovin Player. (Please mind the Casting Requirements)
AdvancedCasting Shows how to implement advanced casting use cases. (Please mind the Casting Requirements)

Advertising

BasicAds Shows how to set up and configure the Bitmovin Player for playback of ads.

UI

CustomHtmlUi Shows how to set up and configured the Bitmovin Player to use a custom HTML UI. Besides, this sample includes how to communicate between the javascript UI and the native code.
SystemUI Shows how to use the system UI instead of the default UI.
BasicFullscreenHandling Shows how to use the BitmovinFullscreenHandler-protocol to implement basic fullscreen handling.

Playlist

BasicPlaylist Shows how to implement queueing / playlists.
BasicPlaylistTV Shows how to implement queueing / playlists in a tvOS application.

Next Up

NextUpTV Shows how to implement next-up feature in a tvOS application

Sample App Setup Instructions

Please execute pod install --repo-update to properly initialize the workspace. In each sample app, you also have to add your Bitmovin Player license key to Info.plist file as BitmovinPlayerLicenseKey or provide it via the PlayerConfig.key property.

In addition to that you have to log in to https://bitmovin.com/dashboard, where you have to add the following bundle identifier of the sample application as an allowed domain under Player -> Licenses:

com.bitmovin.player.samples.playback.basic
com.bitmovin.player.samples.tv.playback.basic
com.bitmovin.player.samples.drm.basic
com.bitmovin.player.samples.casting.basic
com.bitmovin.player.samples.metadata.basic
com.bitmovin.player.samples.custom.ui.html
com.bitmovin.player.samples.ads.basic
com.bitmovin.player.samples.systemui
com.bitmovin.player.samples.offline.basic
com.bitmovin.player.samples.playback.background
com.bitmovin.player.samples.casting.advanced
com.bitmovin.player.samples.fullscreen.basic
com.bitmovin.player.samples.playlist.basic
com.bitmovin.player.samples.tv.playlist.basic

How to integrate the Bitmovin Player iOS SDK

When you want to develop an own iOS application using the Bitmovin Player iOS SDK read through the following steps.

Adding the SDK To Your Project

To add the SDK as a dependency to your project, you have two options: Using CocoaPods or adding the SDK bundle directly.

Using CocoaPods

Add source 'https://github.com/bitmovin/cocoapod-specs.git' to your Podfile.
Run pod repo update to add the newly added source.
Add pod 'BitmovinPlayer', '3.29.0' to your Podfile.
Install the pod using pod install.

See the Podfile of this repository for a full example.

Adding the SDK Directly

When using Xcode, go to the General page or your app target and add the SDK bundle (BitmovinPlayer.xcframework) under Linked Frameworks and Libraries. The latest SDK for iOS and tvOS can be downloaded here.

Prepare your Bitmovin Player license

Add your Bitmovin player license key to the Info.plist file as BitmovinPlayerLicenseKey. Alternatively you can also set the license key via the PlayerConfig.key property when creating a Player instance.

Your player license key can be found when logging in into https://bitmovin.com/dashboard and navigating to Player -> Licenses.
Add the Bundle identifier of the iOS application which is using the SDK as an allowed domain to the Bitmovin licensing backend. This can be also done under Player -> Licenses when logging in into https://dashboard.bitmovin.com with your account.

When you do not do this, you'll get a license error when starting the application which contains the player.

Development Notes

Casting Requirements

If you are using the Google Cast SDK (BasicCasting or AdvancedCasting), make sure the following requirements are met:

Use a provisioning profile with Access WiFi Information enabled
The NSBluetoothAlwaysUsageDescription key is set in the info.plist

Documentation And Release Notes

You can find the latest API documentation here.
The release notes can be found here.

Support

If you have any questions or issues with this SDK or its examples, or you require other technical support for our services, please login to your Bitmovin Dashboard at https://bitmovin.com/dashboard and create a new support case. Our team will get back to you as soon as possible 👍

herrernst / bitmovin-player-ios-samples