THEOplayer is the universal video player solution created by THEO Technologies. And the THEOplayer Android SDK enables you to quickly deliver content playback on Android, Android TV and Fire TV. The Android SDK leverages Java 8 and Kotlin languages to provide safer and more concise code.
A valid THEOplayer license is required to use a THEOplayer SDK. It can be requested via THEOportal.
After creating the THEOplayer license, copy its license string to your clipboard as demonstrated in the screenshot below. Use this license string when setting up THEOplayer.
The THEOplayer SDK consists of modular features.
The core package is responsible for playback of DASH, HLS, LL-HLS sources.
Additional features are provided as separate packages.
To customize your build of the core package, you can add additional dependencies.
For example, if you would like to add Google IMA advertisements to your player you can add the integration-ads-ima:+ dependency.
Below you can find a list containing all currently available dependencies.
Additional feature dependencies will be added in the future.
| Features | Dependency | Release | Documentation |
|---|---|---|---|
| Google IMA | integration-ads-ima:+ |
3.1.0+ | documentation |
| Chromecast | integration-cast:+ |
3.4.0+ | documentation |
| AWS MediaTailor | integration-ads-mediatailor:+ |
4.0.0+ | documentation |
| Google DAI | integration-ads-dai:+ |
4.3.0+ | documentation |
In your project level build.gradle file add the THEOplayer Maven repository:
allprojects {
repositories {
google()
mavenCentral()
maven { url 'https://maven.theoplayer.com/releases' }
}
}
In your module level build.gradle file add one or more THEOplayer dependencies:
implementation 'com.theoplayer.theoplayer-sdk-android:core:+' // Always required
implementation 'com.theoplayer.theoplayer-sdk-android:integration-ads-ima:+'
implementation 'com.theoplayer.theoplayer-sdk-android:integration-cast:+'
implementation 'com.theoplayer.theoplayer-sdk-android:integration-ads-mediatailor:+'
implementation 'com.theoplayer.theoplayer-sdk-android:integration-ads-dai:+'
Notes:
- The
+will fetch the latest released version of THEOplayer SDK. - Android Studio will recommend replacing the
+with the exact version of THEOplayer. - Versions earlier than 5.0.0 (release 2023.3.0) are not available on THEOplayer Maven registry.
The UI element of THEOplayer is called THEOplayerView and it can be instantiated in 2 different ways: through A) XML or through B) the THEOplayer constructor API.
Note the "your_license_here" placeholder string in these two examples.
You want to replace this placeholder string with the license string mentioned in the "Prerequisites".
You can instantiate a THEOplayer instance through XML, as demonstrated by the snippet below.
<com.theoplayer.android.api.THEOplayerView
android:id="@+id/theoPlayerView"
android:layout_width="match_parent"
android:layout_height="400dp" />And then, in the Activity/Fragment, you can reference to it, as demonstrated by the snippet below.
THEOplayerView theoPlayerView = findViewById(R.id.theoPlayerView);Furthermore, you need to configure the license string mentioned in "Prerequisites" in your AndroidManifest.xml.
This file should resemble the snippet below.
<application>
<meta-data
android:name="THEOPLAYER_LICENSE"
android:value="your_license_here" />
</application>In the Activity/Fragment, you can use the constructor API to create a THEOplayer instance
by passing along a context and a THEOplayerConfig.
In this THEOplayerConfig, you must configure your license string, as demonstrated in the snippet below.
THEOplayerConfig playerConfig = new THEOplayerConfig.Builder()
.license("your_license_here")
.build();
THEOplayerView theoPlayerView = new THEOplayerView(this, playerConfig);@Override
protected void onPause() {
super.onPause();
theoPlayerView.onPause();
}
@Override
protected void onResume() {
super.onResume();
theoPlayerView.onResume();
}
@Override
protected void onDestroy() {
super.onDestroy();
theoPlayerView.onDestroy();
}Player theoPlayer = theoPlayerView.getPlayer();TypedSource typedSource = new TypedSource.Builder()
.src(getString(R.string.defaultSourceUrl))
.build();
SourceDescription sourceDescription = new SourceDescription.Builder()
.sources(typedSource)
.poster(getString(R.string.defaultPosterUrl))
.build();
theoPlayer.setSource(sourceDescription.build());theoPlayer.addEventListener(PlayerEventTypes.PLAY, event -> Log.i(TAG, "Event: PLAY"));
theoPlayer.addEventListener(PlayerEventTypes.PLAYING, event -> Log.i(TAG, "Event: PLAYING"));
theoPlayer.addEventListener(PlayerEventTypes.PAUSE, event -> Log.i(TAG, "Event: PAUSE"));
theoPlayer.addEventListener(PlayerEventTypes.ENDED, event -> Log.i(TAG, "Event: ENDED"));
theoPlayer.addEventListener(PlayerEventTypes.ERROR, event -> Log.i(TAG, "Event: ERROR, error=" + event.getErrorObject().getMessage()));That's it! You should now have a working player in your application.
The documentation for THEOplayer is located on our documentation website. For an example on how to setup THEOplayer, take a look at our Getting started guide.
If you are having issues installing or using the package, first look for existing answers on our documentation website, and in particular our FAQ.
You can also contact our technical support team by following the instructions on our support page. Note that your level of support depends on your selected support plan.
The contents of this package are subject to the THEOplayer license.