media/README.md

63 lines
2.3 KiB
Markdown
Raw Normal View History

# ExoPlayer #
2014-06-16 19:55:31 +08:00
ExoPlayer is an application level media player for Android. It provides an
alternative to Androids MediaPlayer API for playing audio and video both
locally and over the Internet. ExoPlayer supports features not currently
supported by Androids MediaPlayer API, including DASH and SmoothStreaming
adaptive playbacks. Unlike the MediaPlayer API, ExoPlayer is easy to customize
and extend, and can be updated through Play Store application updates.
2014-06-16 19:55:31 +08:00
2015-12-11 02:08:39 +08:00
## Documentation ##
* The [developer guide][] provides a wealth of information to help you get
started.
2015-12-11 02:08:39 +08:00
* The [class reference][] documents the ExoPlayer library classes.
* The [release notes][] document the major changes in each release.
[developer guide]: https://google.github.io/ExoPlayer/guide.html
[class reference]: https://google.github.io/ExoPlayer/doc/reference
[release notes]: https://github.com/google/ExoPlayer/blob/dev-v2/RELEASENOTES.md
2015-12-11 02:08:39 +08:00
## Using ExoPlayer ##
The easiest way to get started using ExoPlayer is to add it as a gradle
dependency. You need to make sure you have the jcenter repository included in
the `build.gradle` file in the root of your project:
```gradle
repositories {
jcenter()
}
```
Next, include the following in your module's `build.gradle` file:
```gradle
compile 'com.google.android.exoplayer:exoplayer:rX.X.X'
```
where `rX.X.X` is the your preferred version. For the latest version, see the
project's [Releases][]. For more details, see the project on [Bintray][].
[Releases]: https://github.com/google/ExoPlayer/releases
[Bintray]: https://bintray.com/google/exoplayer/exoplayer/view
## Developing ExoPlayer ##
2015-12-11 02:06:46 +08:00
#### Project branches ####
* The project has `dev-vX` and `release-vX` branches, where `X` is the major
version number.
* Most development work happens on the `dev-vX` branch with the highest major
version number. Pull requests should normally be made to this branch.
* Bug fixes may be submitted to older `dev-vX` branches. When doing this, the
same (or an equivalent) fix should also be submitted to all subsequent
`dev-vX` branches.
* A `release-vX` branch holds the most recent stable release for major version
`X`.
2014-06-16 19:55:31 +08:00
#### Using Android Studio ####
To develop ExoPlayer using Android Studio, simply open the ExoPlayer project in
the root directory of the repository.