Version: 2.67.0

How to do offline DRM on Android

This how-to guide describes how to implement playback of downloadable content-protected MPEG-DASH using the THEOplayer's Android SDK. Currently, widevine is supported together with the Irdeto and DRMToday integrations.

Step-by-step guide

Prerequirements

In order to do offline DRM on Android, your license key should be downloadable, and cacheable. The SDK will not be able to decrypt your content if your key expired.

Before you start, add the following transitive theoplayer dependency to the build.gradle file:

dependencies {
// other dependencies..
implementation 'com.google.android.exoplayer:exoplayer:2.6.1'
}

Code example

The snippet below downloads a Widevine MPEG-DASH asset.

offline-drm-android-1Expand source

private void cacheSource(String sessionId, String src, String amount, Date expirationDate) {
Cache cache = THEOplayerGlobal.getSharedInstance(this).getCache();
DRMConfiguration drmToday = createDrmTodayConfiguration(sessionId);
SourceDescription source = sourceDescription(typedSource(src).drm(drmToday).build()).build();
CachingParameters cachingParameters = new CachingParameters(amount, expirationDate);
CachingTask cachingTask = cache.createTask(source, cachingParameters);
cachingTask.addEventListener(CachingTaskEventTypes.CACHING_TASK_STATE_CHANGE, e -> {
switch (cachingTask.getStatus()) {
case DONE:
// handle success..
break;
case ERROR:
// handle error..
break;
default: // do nothing
break;
}
});
cachingTask.start();
}
private DRMConfiguration createDrmConfiguration(String sessionId) {
KeySystemConfiguration widevine = KeySystemConfiguration.Builder
.keySystemConfiguration(C.LICENSE_ACQUISITION_URL)
.licenseType(LicenseType.PERSISTENT)
.build();
return YOUR_DRM_INTEGRATION_WITH_WIVDEVINE(widevine)
}

To playback cached material, create and play the stream as per usual. The cached content will be used for the known source.

private void playSourceFromCache(String sessionId, String src) {
DRMConfiguration drmConf = createDrmConfiguration(sessionId);
SourceDescription sourceDescription = sourceDescription(typedSource(src).drm(drmConf).build()).build();
tpv.getPlayer().setSource(sourceDescription);
tpv.getPlayer().play();
}

A caching task can be paused and restarted through the task object itself.

private void startAndPauseTask(CachingTask task) {
// When not started, the task will be in the "IDLE" state
task.start();
// The status of the task will now be "LOADING"
task.pause();
// The task reverts back to "IDLE" after finishing its current segment download
task.start();
// The task continues where it was paused
}

After creating a caching task, it is possible to check an estimate for the total size of the caching task on disk, and the current progression in bytes (stored).

private void checkStorageRequirements(CachingTask unstartedTask) {
// We can get an estimate for the amount of space this task will consume. This will be ready once the manifest is preprocessed when the task is created. Starting is not necessary.
System.out.println(unstartedTask.getBytes());
unstartedTask.start();
// ... Additional logic here
// At any time, we can check the current amount of bytes cached by the task
System.out.println(unstartedTask.getBytesCached());
}

Listing and restarting caching tasks

An important side note when calling previously cached tasks is that you need to initialise the cache first. Initialising happens asynchronously, so calling upon the cache immediately after initialising may result in an empty list as it is still initialising. (You could initialise the cache as soon as your app opens, such that you can access it later in other pages in the app - but do note that this opens a new webview and takes around 20MB in cache). To initialise the cache, you need to run the following command:

THEOplayerGlobal theoPlayerGlobal = THEOplayerGlobal.getSharedInstance(this).setApplicationInstance(getApplication());

If you only want to initialise it at the moment that you need it, you can use an eventListener to see when it's initialised, e.g.

Cache cache = THEOplayerGlobal.getSharedInstance(this).getCache()
cache.addEventListener(CacheStateChangeEvent.INITIALISED, e -> {
// Logic once cache is initialised.
// Status can always be fetched using
// cache.getStatus(), which will return the ENUM CacheStateChangeEvent.INITIALISED or CacheStateChangeEvent.UNINITIALISED
});

Once the cache is properly initialised, you can call upon the cache with methods such as "getTasks()" which will return a TaskList that you can iterate through to find previously cached tasks and resume caching or play the resource. Example:

// If you're in a different activity, you can always call upon the previously initialised cache
THEOplayerGlobal theoPlayerGlobal = THEOplayerGlobal.getSharedInstance(this);
// Loop over previously cached tasks
Iterator cachedVideos = theoPlayerGlobal.getCache().getTasks().iterator();
while(cachedVideos.hasNext()) {
CachingTask cachedVideo = (CachingTask) cachedVideos.next();
// Do logic with the found cached video e.g.
CachingTaskStatus status = cachedVideo.getStatus();
SourceDescription sourceDescription = cachedVideo.getSource();
Double percentageCached = cachedVideo.getPercentageCached();
cachedVideo.pause(); // Pause if not already paused
cachedVideo.start(); // start or resume caching task}

For all possible API calls, we refer you to the JavaDoc available in the License that you've received. (Next to the Android SDK there should be a source file with the complete JavaDoc that also describes all possible caching methods).