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
}

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

Next, add the following to your project's settings.gradle.kts file, replacing path/to/media with the path to your local copy:

import androidx.media3.buildlogic.includeMedia3

pluginManagement {
  includeBuild("path/to/media/build-logic-settings")
  // your other plugins
}
plugins {
  id("gradlebuild.media3-settings-logic")
  // your other plugins
}

includeMedia3(file("path/to/media"))

Or in Gradle Groovy DSL settings.gradle:

pluginManagement {
    includeBuild('path/to/media/build-logic-settings')
}

plugins {
    id 'gradlebuild.media3-settings-logic'
}

includeMedia3.execute(file('path/to/media'))

The AndroidX Media checkout will now appear as a separate included build side-by-side with your main project. You can depend on the individual modules from your app's build.gradle.kts as you would on any other module. Gradle will resolve those seemingly published releases as a local checkout.

If your project depends on a particular version of Media3 (here: 1.X.X), it will be completely ignored, so you can leave your build files intact. For example:

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'

If you are getting NDK not configured error, check that path/to/media/local.properties has sdk.dir variable set. It will be autogenerated and populated if you open path/to/media project in your Android Studio.

MIDI module

By default, the MIDI module is disabled as a local dependency, because it requires additional Maven repository config. If you want to use it as a local dependency, please configure the JitPack repository as described in the module README, and then enable building the module in by modifying modules.kt file:

Media3Module("libraries/decoder_midi", "media3-exoplayer-midi", includeInCompositeBuild = true)

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.

Latest commit

History

Folders and files