React Native THEOplayer

License

This projects falls under the license as defined in https://github.com/THEOplayer/license-and-disclaimer.

Table of Contents

1. Overview
2. Prerequisites
3. How to use these guides
4. Features
5. Available connectors
6. Creating your first app
7. Knowledge Base
8. API Reference

Overview

The react-native-theoplayer package provides a THEOplayerView component supporting video playback on the
following platforms:

- Android, Android TV & FireTV
- iOS & tvOS (Apple TV)
- HTML5, Tizen & webOS (web, mobile web, smart TVs, set-top boxes and gaming consoles).

This document covers the creation of a minimal app including a THEOplayerView component,
and an overview of the accompanying example app with a user interface provided
by the @theoplayer/react-native-ui package.

It also gives a description of the properties of the THEOplayerView component, and
a list of features and known limitations.

Prerequisites

For each platform, a dependency to the corresponding THEOplayer SDK is included through a dependency manager:

- Gradle & Maven for Android
- Cocoapods for iOS
- npm for Web

In order to use one of these THEOplayer SDKs, it is necessary to obtain a valid THEOplayer license for that specific platform,
i.e. HTML5, Android, and/or iOS. You can sign up for a THEOplayer SDK license through our portal.

If you have no previous experience in React Native, we encourage you to first explore the
React Native Documentation,
as it gives you a good start on one of the most popular app development frameworks.

How to use these guides

These are guides on how to use the THEOplayer React Native SDK in your React Native project(s) and can be used
linearly or by searching the specific section. It is recommended that you have a basic understanding of how
React Native works to speed up the way of working with THEOplayer React Native SDK.

Features

Depending on the platform on which the application is deployed, a different set of features is available.

If a feature missing, additional help is needed, or you need to extend the package,
please reach out to us for support.

Available connectors

The react-native-theoplayer package can be combined with any number of connectors to provide extra
functionality. Currently, the following connectors are available:

| Connector | npm package | Source |
|-----------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------|
| Adobe Heartbeat analytics using the Media Collections API |  | Adobe |
| Adobe Media Edge analytics |  | Adobe Edge |
| Agama analytics |  | Agama |
| Comscore analytics |  | Comscore |
| Conviva analytics |  | Conviva |
| Engage |  | Engage |
| Gemius |  | Gemius |
| Mux analytics |  | Mux |
| Nielsen analytics |  | Nielsen |
| Nielsen AdScript analytics |  | AdScript |
| Youbora analytics |  | Youbora |
| Yospace SSAI |  | Yospace |
| Content protection (DRM) |  | DRM |
| React Native Open UI |  | Open UI |
| A template for
react-native-theoplayer connectors. |  | Connector template |

Creating your first app

This section starts with creating a minimal demo app that integrates the react-native-theoplayer package,
followed by an overview of the available properties and functionality of the THEOplayerView component.
An example application including a basic user interface and demo sources is included in the
git repository,
and discussed in the next section.

- Creating a minimal demo app
- Getting started on Android
- Getting started on iOS
- Getting started on Web
- The THEOplayerView component
- The example application

Knowledge Base

This section gives an overview of features, limitations and known issues:

- Adaptive Bitrate (ABR)
- Advertisements
- Android Media3 Pipeline
- Audio Control Management
- Background playback and notifications
- Casting with Chromecast and Airplay
- Common Media Client Data (CMCD)
- Digital Rights Management (DRM)
- Expo
- Fullscreen presentation
- Media Caching
- Migrating to THEOplayer 9.x
- Migrating to THEOplayer 10.x🔥
- Millicast
- Picture-in-Picture (PiP)
- Subtitles, Closed Captions and Metadata tracks
- Limitations and known issues

API Reference

See the API Reference for detailed documentation
about all available components and functions.