Skip to content

Latest commit

 

History

History
144 lines (107 loc) · 5.55 KB

README.md

File metadata and controls

144 lines (107 loc) · 5.55 KB
Raw

ExoPlayer

ExoPlayer is an application level media player for Android. The latest version is published as part of AndroidX Media under a new package name and all future development will be in that project.

This project is deprecated. All users should migrate to AndroidX Media3. Please refer to our migration guide and script to move your codebase to the Media3 package names.

  • We plan to release exoplayer2.X.Y artifacts that match media3:1.1.Y bugfix releases (e.g. we will release exoplayer:2.19.1 to match media3:1.1.1).
  • We don't plan to release any exoplayer:2.X.Y artifacts that match media3:1.2.Y releases (or later).
  • We plan to continue pushing commits to the dev-v2 branch in this repository until March 2024.

Documentation

  • The developer guide provides a wealth of information.
  • The class reference documents ExoPlayer classes. Note that the classes are documented with their Media3 package names.
  • The release notes document the major changes in each release.
  • Follow our developer blog to keep up to date with the latest ExoPlayer developments!

Using ExoPlayer

Please refer to AndroidX Media for the usage instructions of the latest release.

ExoPlayer modules can be obtained from the Google Maven repository. It's also possible to clone the repository and depend on the modules locally.

From the Google Maven repository

1. Add ExoPlayer module dependencies

The easiest way to get started using ExoPlayer is to add it as a gradle dependency in the build.gradle file of your app module. The following will add a dependency to the full library:

implementation 'com.google.android.exoplayer:exoplayer:2.X.X'

where 2.X.X is your preferred version.

As an alternative to the full library, you can depend on only the library modules that you actually need. For example the following will add dependencies on the Core, DASH and UI library modules, as might be required for an app that only plays DASH content:

implementation 'com.google.android.exoplayer:exoplayer-core:2.X.X'
implementation 'com.google.android.exoplayer:exoplayer-dash:2.X.X'
implementation 'com.google.android.exoplayer:exoplayer-ui:2.X.X'

When depending on individual modules they must all be the same version.

The available library modules are listed below. Adding a dependency to the full ExoPlayer library is equivalent to adding dependencies on all of the library modules individually.

  • exoplayer-core: Core functionality (required).
  • exoplayer-dash: Support for DASH content.
  • exoplayer-hls: Support for HLS content.
  • exoplayer-rtsp: Support for RTSP content.
  • exoplayer-smoothstreaming: Support for SmoothStreaming content.
  • exoplayer-transformer: Media transformation functionality.
  • exoplayer-ui: UI components and resources for use with ExoPlayer.

In addition to library modules, ExoPlayer has extension modules that depend on external libraries to provide additional functionality. Some extensions are available from the Maven repository, whereas others must be built manually. Browse the extensions directory and their individual READMEs for details.

More information on the library and extension modules that are available can be found on the Google Maven ExoPlayer page.

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 ExoPlayer, 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 ExoPlayer extension modules. It's also a suitable approach if you want to make local changes to ExoPlayer, or if you want to use a development branch.

First, clone the repository into a local directory:

git clone https://github.com/google/ExoPlayer.git
cd ExoPlayer

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

gradle.ext.exoplayerModulePrefix = 'exoplayer-'
apply from: file("path/to/exoplayer/core_settings.gradle")

You should now see the ExoPlayer modules appear as part of your project. You can depend on them as you would on any other local module, for example:

implementation project(':exoplayer-library-core')
implementation project(':exoplayer-library-dash')
implementation project(':exoplayer-library-ui')