aba15b6952
Changes --- - Added `removeOfflineLicense(byte[])` and `getOfflineLicenseKeySetIds` and consumed them in their implementations Background --- - These APIs will help in addressing an increasing amount of `java.lang.IllegalArgumentException: Failed to restore keys: BAD_VALUE` which is our top playback error in our app - Based on our discussion with Widevine team and [this exoplayer issue](https://github.com/google/ExoPlayer/issues/11202#issuecomment-1708792594) - TL;DR: The failure occurs on startup if the user has 200+ offline licenses, we would like to add the functionality to remove offline licenses **Note: Why we want these APIs in ExoMediaDrm and not in OfflineLicenseHelper** - As per the issue above, we would like to access these 2 public APIs in MediaDrm that don’t exist in `OfflineLicenseHelper` or `ExoMediaDrm` - APIs interested in: - [MediaDrm#removeOfflineLicense()](https://developer.android.com/reference/android/media/MediaDrm#removeOfflineLicense(byte%5B%5D)): To remove offline license - [MediaDrm#getOfflineLicenseKeySetIds()](https://developer.android.com/reference/android/media/MediaDrm#getOfflineLicenseKeySetIds()): To see number of offline licenses on startup - We use `OfflineLicenseHelper` to download license for L1 and we don't interact with `ExoMediaDrm` directly. But for the alternate Widevine integration, we directly depend on `ExoMediaDrm` APIs to override and call CDM Native APIs. - We would like to have the functionality of removing offline licenses for both integration which would need access to above APIs in `ExoMediaDrm`. Links --- - https://github.com/androidx/media/issues/659
AndroidX Media
AndroidX Media is a collection of libraries for implementing media use cases on Android, including local playback (via ExoPlayer), video editing (via Transformer) and media sessions.
Documentation
- The developer guide provides a wealth of information.
- The class reference documents the classes and methods.
- The release notes document the major changes in each release.
- The media dev center provides samples and guidelines.
- Follow our developer blog to keep up to date with the latest developments!
Migration for existing ExoPlayer and MediaSession projects
You'll find a migration guide for existing ExoPlayer and MediaSession users on developer.android.com.
API stability
AndroidX Media releases provide API stability guarantees, ensuring that the API surface remains backwards compatible for the most commonly used APIs. APIs intended for more advanced use cases are marked as unstable. To use an unstable method or class without lint warnings, you’ll need to add the OptIn annotation before using it. For more information see the UnstableApi documentation.
Using the libraries
You can get the libraries from the Google Maven repository. It's also possible to clone this GitHub repository and depend on the modules locally.
From the Google Maven repository
1. Add module dependencies
The easiest way to get started using AndroidX Media is to add gradle
dependencies on the libraries you need in the build.gradle.kts file of your
app module.
For example, to depend on ExoPlayer with DASH playback support and UI components you can add dependencies on the modules like this:
implementation("androidx.media3:media3-exoplayer:1.X.X")
implementation("androidx.media3:media3-exoplayer-dash:1.X.X")
implementation("androidx.media3:media3-ui:1.X.X")
Or in Gradle Groovy DSL build.gradle:
implementation 'androidx.media3:media3-exoplayer:1.X.X'
implementation 'androidx.media3:media3-exoplayer-dash:1.X.X'
implementation 'androidx.media3:media3-ui:1.X.X'
where 1.X.X is your preferred version. All modules must be the same version.
Please see the AndroidX Media3 developer.android.com page for more information, including a full list of library modules.
This repository includes some modules that depend on external libraries that need to be built manually, and are not available from the Maven repository. Please see the individual READMEs under the libraries directory for more details.
2. Turn on Java 8 support
If not enabled already, you also need to turn on Java 8 support in all
build.gradle.kts files depending on AndroidX Media, by adding the following to
the android section:
compileOptions {
targetCompatibility = JavaVersion.VERSION_1_8
}
Or in Gradle Groovy DSL build.gradle:
compileOptions {
targetCompatibility JavaVersion.VERSION_1_8
}
3. Enable multidex
If your Gradle minSdkVersion is 20 or lower, you should
enable multidex in order
to prevent build errors.
Locally
Cloning the repository and depending on the modules locally is required when
using some libraries. It's also a suitable approach if you want to make local
changes, or if you want to use the main branch.
First, clone the repository into a local directory:
git clone https://github.com/androidx/media.git
cd media
Next, add the following to your project's settings.gradle.kts file, replacing
path/to/media with the path to your local copy:
gradle.extra.apply {
set("androidxMediaModulePrefix", "media-")
}
apply(from = file("path/to/media/core_settings.gradle"))
Or in Gradle Groovy DSL settings.gradle:
gradle.ext.androidxMediaModulePrefix = 'media-'
apply from: file("path/to/media/core_settings.gradle")
You should now see the AndroidX Media modules appear as part of your project.
You can depend on them from build.gradle.kts as you would on any other local
module, for example:
implementation(project(":media-lib-exoplayer"))
implementation(project(":media-lib-exoplayer-dash"))
implementation(project(":media-lib-ui"))
Or in Gradle Groovy DSL build.gradle:
implementation project(':media-lib-exoplayer')
implementation project(':media-lib-exoplayer-dash')
implementation project(':media-lib-ui')
Developing AndroidX Media
Project branches
Development work happens on the main branch. Pull requests should normally be
made to this branch.
The release branch holds the most recent stable release.
Using Android Studio
To develop AndroidX Media using Android Studio, simply open the project in the root directory of this repository.