theoplayer 1.0.0 copy "theoplayer: ^1.0.0" to clipboard
theoplayer: ^1.0.0 copied to clipboard

THEOplayer Flutter SDK

THEOplayer Flutter SDK #

Table of Contents #

  1. Overview
  2. Prerequisites
  3. How to use these guides
  4. Features
  5. Getting Started

Overview #

The theoplayer package provides a THEOplayer component supporting video playback on the following platforms:

  • Android, Android TV & FireTV
  • iOS
  • HTML5 (web, mobile web)
  • OUT OF SCOPE: Tizen and WebOS (smart TVs, set-top boxes and gaming consoles).

This document covers the creation of a minimal app including a THEOplayer component, and an overview of the accompanying example app.

It also gives a description of the properties of the THEOplayer 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 *

*the initial version of the SDK relies on a local copy of THEOplayer.chromeless.js (and additional modules), so adding it manually is required!

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 use your existing THEOplayer SDK license or request a free trial account.

If you have no previous experience in Flutter, we encourage you to first explore the Flutter 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 Flutter SDK in your Flutter project(s) and can be used linearly or by searching the specific section. It is recommended that you have a basic understanding of how Flutter works to speed up the way of working with THEOplayer Flutter SDK.

Features #

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

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

Getting Started #

This section starts with creating a minimal demo app that integrates the flutter_theoplayer_sdk package, followed by an overview of the available properties and functionality of the THEOplayer component. A minimal example application including a basic user interface and demo sources is included in this repository, and discussed in the next section. Finally, an overview of features, limitations and known issues is listed.