No description
Find a file
tonihei ecb9d5988e Enfore minCompileSdk version when depending on ExoPlayer/Media3 libs
If an app sets a compileSdkVersion that is lower than the one used to
create AARs of its dependencies, the build process may produce invalid
outputs, for example by stripping methods from the APK that are only
called when the app is running on a new API version.

To avoid this issue, we can enforce that the compileSdk of apps or
libraries depending on ExoPlayer/Media3 is at least the same as the
one we used for compilation when creating the AAR.

Issue: google/ExoPlayer#10684
PiperOrigin-RevId: 485100067
(cherry picked from commit 136b8c57d9)
2022-10-31 18:13:59 +00:00
.github/ISSUE_TEMPLATE Version bump to exoplayer:2.18.1 and media3:1.0.0-beta02 2022-07-15 10:39:34 +00:00
.idea Disable automatic imports for inner classes 2018-07-26 18:27:46 +01:00
demos Make adding ad live breaks more robust 2022-10-27 11:10:10 +00:00
github Add migration script 2022-07-12 20:43:24 +00:00
gradle/wrapper Update the Gradle Wrapper and Android Gradle Plugin 2022-05-30 20:53:20 +00:00
libraries Disable failing tests of FlacExtractorSeekTest 2022-10-31 15:53:41 +00:00
.gitignore Add JSyn library build instructions for the MIDI module 2022-08-09 15:44:44 +00:00
api.txt Group COMMAND_SET_MEDIA_ITEM and COMMAND_CHANGE_MEDIA_ITEMS together 2022-07-12 14:06:27 +00:00
build.gradle Update the Gradle Wrapper and Android Gradle Plugin 2022-05-30 20:53:20 +00:00
common_library_config.gradle Enfore minCompileSdk version when depending on ExoPlayer/Media3 libs 2022-10-31 18:13:59 +00:00
constants.gradle Bump appTargetSDKVersion to 33 2022-10-28 13:22:07 +00:00
CONTRIBUTING.md Tighten the wording for sending a pull request. 2022-10-31 13:55:24 +00:00
core_settings.gradle Create effect module. 2022-08-02 12:36:47 +00:00
gradle.properties Update Gradle jetifier config to use non-deprecated option 2021-07-09 09:07:03 +01:00
gradlew Update the gradle wrapper scripts 2022-03-01 09:34:07 +00:00
gradlew.bat Update the gradle wrapper scripts 2022-03-01 09:34:07 +00:00
javadoc_combined.gradle Upgrade dackka and fix some generation errors 2022-10-28 10:03:56 +00: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
LICENSE Initial drop. 1.0.10. 2014-06-16 12:56:04 +01:00
lint.xml Enable unstable API errors in the dev guide samples and main demo app 2022-05-09 10:52:57 +01:00
missing_aar_type_workaround.gradle Wrap expression in paranthesis 2022-01-28 08:47:49 +00:00
publish.gradle Add workaround for missing <type>aar</type> tags in POM 2022-01-05 10:48:41 +00:00
README.md Update README for beta release. 2022-08-08 09:46:09 +00:00
RELEASENOTES.md Enfore minCompileSdk version when depending on ExoPlayer/Media3 libs 2022-10-31 18:13:59 +00:00
SECURITY.md Update security mailing list 2021-11-09 10:09:26 +00:00
settings.gradle Publish the transformer demo app 2022-01-28 16:48:06 +00:00

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 beta and we welcome your feedback via the issue tracker. Please consult the release notes for more details about the beta 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 beta 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.

You'll find some Media3 documentation on developer.android.com, including a migration guide for existing ExoPlayer and MediaSession users.

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, youll need to add the OptIn annotation before using it. 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:

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

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.

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.