IntroductionHow to update an SDK?THEOplayer 5.0 - Native Mobile iOS/tvOS and Android SDKs
Getting started on Web (Extended)Getting started with the new Web UIGetting started on WebAPI examplesHow to implement Keyboard HotkeysHow to embed an iframeHow to implement a seamless transition between videos?How can I use video inside THEOplayer?How to work around browser cache with a new license?How to customise quality selection & labels (MP4)How to get frame-accurate currentTime display in the UI Control barHow to play an LCEVC source with THEOplayerHow to use WebXR with THEOplayer
Android legacy (4.12.x)
Getting started on Legacy Android SDK (4.12.x)Legacy Android SDK (4.12.x) customizationHow to couple the native MediaRouteButton to THEOplayerHow to enable -experimental- native rendering on AndroidHow to do offline Playback with AES-128 Encrypted Streams on Android
Getting started with the Android UIGetting started on AndroidAndroid Feature IntegrationsMigration from THEOplayer Android/AndroidTV/FireTV SDK 4.x to THEOplayer Android SDK 5.0
iOS legacy (4.12.x)
Getting started on iOSiOS/tvOS SDK and Legacy iOS/tvOS SDK (4.12.x) CustomizationMy app does not want to build for the app storeHow to bypass copy() not working in Safari consoleHow to couple the native GCKUICastButton to THEOplayeriOS/tvOS SDK and Legacy iOS/tvOS SDK (4.12.x) Touch-events (gestures)Building for iOS Simulator, but the linked and embedded framework THEOplayerSDK.framework was built for iOS + iOS SimulatorHow to implement custom local network access (LNA) interstitial dialog for Chromecast
Getting started guide for THEOplayer iOS/tvOS SDK 5.0THEOplayer iOS/tvOS 5.0 Feature IntegrationsMigration from THEOplayer iOS and tvOS SDK 4.x to THEOplayer iOS/tvOS SDK 5.0
Android TV Legacy (4.12.x)
Getting started on Android TV Legacy (4.12.x)
Getting started on tvOS
Getting started on ChromecastChromecast Application Customization
Getting Started on webOS
Getting started on TizenInstalling the Tizen developer toolsSetting up a Tizen device for debuggingDeploying a test app on a physical Tizen deviceDeploying a test app on a Tizen emulator
Getting Started on Roku
Fire TV Legacy (4.12.x)
Getting started on Fire TV Legacy (4.12.x)

Migration from THEOplayer Android/AndroidTV/FireTV SDK 4.x to THEOplayer Android SDK 5.0

What are the differences between Android SDK and Legacy Android SDKs (4.12.x)?

The Android SDK is significantly more performant than the Legacy Android SDKs (4.12.x), as it removes the dependency on the WebView to handle video-playback and supported features. Removing the WebView dependency also allowed to move many of the APIs from being asynchronous to being synchronous, such as querying the current time.

Another difference between the SDKs is that with Android SDK users will no longer need to maintain multiple flavors for different platforms or Android OS version. This because the Android SDK works on Android mobile, Android TV and Fire TV devices with Android OS version 5.0+ (API level 21 and above).

The Android SDK moves towards more modularized features, which means there is a base SDK that can handle basic playback and additional feature integrations are provided as separate modules that can be added as desired. This approach gives more flexibility and results in a reduced application size, since non-required parts are not included in the build of the application. You can read more about this here.

The Android SDK leverages Java 8 and Kotlin languages to provide safer and more concise code.

Lastly, the Android SDK is released on JitPack which allow developers to easily fetch and implement the player into their app.

When to migrate?

THEOplayer Android SDK 5.0 is a more performant version of our SDK, so we advise you to migrate as soon as possible.

However, the 5.0 SDK is built from the ground up so from day 1 it will be not in feature parity with the legacy SDKs.

What features are covered already in THEOplayer Android SDK 5.0?

If the implemented features are covering your use-cases, feel free to upgrade. The changes due to deprecations in your code will be minimal, THEOplayer Android SDK 5.0 tries to be backward compatible with the legacy 4.x APIs as much as possible.

When not to migrate?

If your use-cases rely on missing features and you can not implement them on top of the player.

Some features, like:

  • Analytics pre-integrations: Agama, Moat, Conviva, Youbora
  • Advertisement pre-integrations: THEOAds, Spotx
  • Server-side ad insertion: Yospace, Verizon Media

Or features which brought to life via the WebView's middle layer:

  • Related Content API
  • Javascript execution
  • CSS injection

Or you rely on the default THEOplayer UI.

The current THEOplayer Android SDK 5.0 is chromeless, it means you need to implement your own native UI on top of the player.

Soon we will also release a fully native, customizable UI module (connector). Stay tuned!


There are 2 main things you need to consider during migration:

1. The deprecated (and removed) APIs.

For these ones please consult with our changelog

2. The new integration-based architecture.

You can read more about the new architecture here.

To migrate each modularized feature, please visit our Features subpage.

After these steps you should be able to compile your project and benefit from THEOplayer Android SDK 5.0.

The Google Cast and Google IMA/DAI integration APIs are mapped to theoplayer.ads and theoplayer.cast.chromecast APIs, but you can also access the same APIs (and new ones) on the integrations itself.

Make sure to follow us on GitHub!
Copyright © 2022. All Rights Reserved.
New York