Go to file
olly 49271ec74f Update security mailing list
PiperOrigin-RevId: 407540705
2021-11-09 10:09:26 +00:00
.github/ISSUE_TEMPLATE Update to androidx.media3 2021-10-27 09:12:46 +01:00
.idea Disable automatic imports for inner classes 2018-07-26 18:27:46 +01:00
demos Fix implementations of MediaLibrarySessionCallback to pass `params` 2021-11-09 10:09:12 +00:00
gradle/wrapper Upgrade to gradle 7.0.2 2021-08-06 15:57:25 +01:00
libraries Write sample size to dumpfile in transformer tests. 2021-11-09 10:09:13 +00:00
.gitignore Add jacoco.exec files to .gitignore 2021-02-23 16:53:06 +00:00
CONTRIBUTING.md Update to androidx.media3 2021-10-27 09:12:46 +01:00
LICENSE Initial drop. 1.0.10. 2014-06-16 12:56:04 +01:00
README.md Elaborate migration info in media3 README 2021-10-27 17:52:39 +01:00
RELEASENOTES.md Update to androidx.media3 2021-10-27 09:12:46 +01:00
SECURITY.md Update security mailing list 2021-11-09 10:09:26 +00:00
build.gradle Upgrade gradle plugin version 2021-11-09 10:07:00 +00:00
common_library_config.gradle Update to androidx.media3 2021-10-27 09:12:46 +01:00
constants.gradle Update to androidx.media3 2021-10-27 09:12:46 +01:00
core_settings.gradle Update to androidx.media3 2021-10-27 09:12:46 +01:00
gradle.properties Update Gradle jetifier config to use non-deprecated option 2021-07-09 09:07:03 +01:00
gradlew Initial drop. 1.0.10. 2014-06-16 12:56:04 +01:00
gradlew.bat Cleanup following #884 2015-10-27 21:03:16 +00:00
javadoc_combined.gradle Fix gradle sync error 2021-09-24 17:58:26 +01:00
javadoc_library.gradle Fix search links in generated Javadoc 2021-05-12 13:55:08 +01:00
javadoc_util.gradle Make javadoc links point to Android docs for java.* classes 2020-04-01 22:38:01 +01:00
lint.xml Update to androidx.media3 2021-10-27 09:12:46 +01:00
publish.gradle Update to androidx.media3 2021-10-27 09:12:46 +01:00
settings.gradle Update to androidx.media3 2021-10-27 09:12:46 +01:00

README.md

AndroidX Media

AndroidX Media is a collection of libraries for implementing media use cases on Android, including local playback (via ExoPlayer) and media sessions.

Current status

AndroidX Media is currently in alpha and we welcome your feedback via the issue tracker. Please consult the release notes for more details about the alpha release.

ExoPlayer's new home will be in AndroidX Media, but for now we are publishing it both in AndroidX Media and via the existing ExoPlayer project. While AndroidX Media is in alpha we recommend that production apps using ExoPlayer continue to depend on the existing ExoPlayer project. We are still handling ExoPlayer issues on the ExoPlayer issue tracker.

Updated documentation, including more information on migration and a developer guide, is coming soon. For existing ExoPlayer users, the most important change is that all classes have been moved to new packages under androidx.media3.

AndroidX Media alpha releases provide no guarantees about API stability, but the codebase includes API stability marking for non-alpha releases. If you see lint errors from using the unstable API surface, you can opt-in by annotating the relevant code or disabling the lint check entirely. For more information see the UnstableApi documentation.

For a high level overview of the initial version of AndroidX Media please see the Android Dev Summit talk What's next for AndroidX Media and ExoPlayer.

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 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'

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 files depending on AndroidX Media, by adding the following to the android section:

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 and checkout the desired branch:

git clone https://github.com/androidx/media.git
cd media
git checkout main

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

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 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')

Developing AndroidX Media

Project branches

Development work happens on the main branch. Pull requests should normally be made to this branch.

We plan to add a release branch soon.

Using Android Studio

To develop AndroidX Media using Android Studio, simply open the project in the root directory of this repository.