https://github.com/theoplayer/flutter-theolive-sdk

THEOlive Flutter SDK
https://github.com/theoplayer/flutter-theolive-sdk

Last synced: 30 days ago
JSON representation

THEOlive Flutter SDK

• Host: GitHub
• URL: https://github.com/theoplayer/flutter-theolive-sdk
• Owner: THEOplayer
• License: other
• Created: 2023-07-14T12:17:39.000Z (over 1 year ago)
• Default Branch: develop
• Last Pushed: 2024-08-08T09:21:47.000Z (6 months ago)
• Last Synced: 2024-08-13T09:35:18.170Z (6 months ago)
• Language: Dart
• Size: 298 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        


# THEOlive Flutter SDK

## Table of Contents

1. [Overview](#overview)

2. [Prerequisites](#prerequisites)

3. [How to use these guides](#how-to-use-these-guides)

4. [Features](#features)

6. [Getting Started](#getting-started)

## Overview

The `theolive` package provides a `THEOlive` component supporting video playback on the following platforms:

- Android, Android TV & FireTV

- iOS 

- **OUT OF SCOPE**: HTML5 (web, mobile web), Tizen and WebOS (smart TVs, set-top boxes and gaming consoles).

This document covers the creation of a minimal app including a `THEOlive` component,

and an overview of the accompanying example app.

## Prerequisites

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

- Gradle & Maven for Android

- Cocoapods for iOS

If you have no previous experience in Flutter, we encourage you to first explore the

[Flutter Documentation](https://docs.flutter.dev/),

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 THEOlive 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 THEOlive Flutter SDK.

## Features

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

If a feature 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 `theolive` package.

A minimal example application including a basic user interface and a demo source is included in [this git repository](https://github.com/THEOplayer/flutter-theolive-sdk/tree/main/example),

and parts of it are discussed in the next section.

- [Creating a minimal demo app](https://github.com/THEOplayer/flutter-theolive-sdk/blob/main/doc/creating-minimal-app.md)

    - [Getting started on Android](https://github.com/THEOplayer/flutter-theolive-sdk/blob/main/doc/creating-minimal-app.md#getting-started-on-android)

    - [Getting started on iOS](https://github.com/THEOplayer/flutter-theolive-sdk/blob/main/doc/creating-minimal-app.md#getting-started-on-ios)

- Knowledge Base

  - [Using different rendering targets on Android](https://github.com/THEOplayer/flutter-theolive-sdk/blob/main/doc/android_rendering.md)

- [Limitations and known issues](https://github.com/THEOplayer/flutter-theolive-sdk/blob/main/doc/limitations.md)