Skip to content

Commit 4ce862a

Browse files
ojw28Oliver Woodman
authored and
Oliver Woodman
committed
Tweak and add READMEs + remove refs to V1
------------- Created by MOE: https://github.com/google/moe MOE_MIGRATED_REVID=165578518
1 parent b174bcc commit 4ce862a

File tree

20 files changed

+185
-56
lines changed

20 files changed

+185
-56
lines changed

Diff for: README.md

+25-26
Original file line numberDiff line numberDiff line change
@@ -9,37 +9,37 @@ and extend, and can be updated through Play Store application updates.
99

1010
## Documentation ##
1111

12-
* The [developer guide][] provides a wealth of information to help you get
13-
started.
14-
* The [class reference][] documents the ExoPlayer library classes.
12+
* The [developer guide][] provides a wealth of information.
13+
* The [class reference][] documents ExoPlayer classes.
1514
* The [release notes][] document the major changes in each release.
15+
* Follow our [developer blog][] to keep up to date with the latest ExoPlayer
16+
developments!
1617

1718
[developer guide]: https://google.github.io/ExoPlayer/guide.html
1819
[class reference]: https://google.github.io/ExoPlayer/doc/reference
19-
[release notes]: https://github.com/google/ExoPlayer/blob/dev-v2/RELEASENOTES.md
20+
[release notes]: https://github.com/google/ExoPlayer/blob/release-v2/RELEASENOTES.md
21+
[developer blog]: https://medium.com/google-exoplayer
2022

2123
## Using ExoPlayer ##
2224

23-
ExoPlayer modules can be obtained via JCenter. It's also possible to clone the
25+
ExoPlayer modules can be obtained from JCenter. It's also possible to clone the
2426
repository and depend on the modules locally.
2527

26-
### Via JCenter ###
28+
### From JCenter ###
2729

2830
The easiest way to get started using ExoPlayer is to add it as a gradle
29-
dependency. You need to make sure you have the JCenter and Google Maven
30-
repositories included in the `build.gradle` file in the root of your project:
31+
dependency. You need to make sure you have the JCenter and Google repositories
32+
included in the `build.gradle` file in the root of your project:
3133

3234
```gradle
3335
repositories {
3436
jcenter()
35-
maven {
36-
url "https://maven.google.com"
37-
}
37+
google()
3838
}
3939
```
4040

4141
Next add a gradle compile dependency to the `build.gradle` file of your app
42-
module. The following will add a dependency to the full ExoPlayer library:
42+
module. The following will add a dependency to the full library:
4343

4444
```gradle
4545
compile 'com.google.android.exoplayer:exoplayer:r2.X.X'
@@ -56,8 +56,8 @@ compile 'com.google.android.exoplayer:exoplayer-dash:r2.X.X'
5656
compile 'com.google.android.exoplayer:exoplayer-ui:r2.X.X'
5757
```
5858

59-
The available modules are listed below. Adding a dependency to the full
60-
ExoPlayer library is equivalent to adding dependencies on all of the modules
59+
The available library modules are listed below. Adding a dependency to the full
60+
library is equivalent to adding dependencies on all of the library modules
6161
individually.
6262

6363
* `exoplayer-core`: Core functionality (required).
@@ -66,11 +66,16 @@ individually.
6666
* `exoplayer-smoothstreaming`: Support for SmoothStreaming content.
6767
* `exoplayer-ui`: UI components and resources for use with ExoPlayer.
6868

69-
For more details, see the project on [Bintray][]. For information about the
70-
latest versions, see the [Release notes][].
69+
In addition to library modules, ExoPlayer has multiple extension modules that
70+
depend on external libraries to provide additional functionality. Some
71+
extensions are available from JCenter, whereas others must be built manaully.
72+
Browse the [extensions directory] and their individual READMEs for details.
7173

74+
More information on the library and extension modules that are available from
75+
JCenter can be found on [Bintray][].
76+
77+
[extensions directory][]: https://github.com/google/ExoPlayer/tree/release-v2/extensions/
7278
[Bintray]: https://bintray.com/google/exoplayer
73-
[Release notes]: https://github.com/google/ExoPlayer/blob/release-v2/RELEASENOTES.md
7479

7580
### Locally ###
7681

@@ -109,15 +114,9 @@ compile project(':exoplayer-library-ui')
109114

110115
#### Project branches ####
111116

112-
* The project has `dev-vX` and `release-vX` branches, where `X` is the major
113-
version number.
114-
* Most development work happens on the `dev-vX` branch with the highest major
115-
version number. Pull requests should normally be made to this branch.
116-
* Bug fixes may be submitted to older `dev-vX` branches. When doing this, the
117-
same (or an equivalent) fix should also be submitted to all subsequent
118-
`dev-vX` branches.
119-
* A `release-vX` branch holds the most recent stable release for major version
120-
`X`.
117+
* Development work happens on the `dev-v2` branch. Pull requests should
118+
normally be made to this branch.
119+
* The `release-v2` branch holds the most recent release.
121120

122121
#### Using Android Studio ####
123122

Diff for: demo/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
# Demo application #
1+
# ExoPlayer main demo #
22

3-
This folder contains a demo application that uses ExoPlayer to play a number
3+
This is the main ExoPlayer demo application. It uses ExoPlayer to play a number
44
of test streams. It can be used as a starting point or reference project when
55
developing other applications that make use of the ExoPlayer library.

Diff for: extensions/README.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# ExoPlayer extensions #
2+
3+
ExoPlayer extensions are modules that depend on external libraries to provide
4+
additional functionality. Browse the individual extensions and their READMEs to
5+
learn more.

Diff for: extensions/cronet/README.md

+7-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# ExoPlayer Cronet extension #
22

3-
## Description ##
4-
53
The Cronet extension is an [HttpDataSource][] implementation using [Cronet][].
64

75
[HttpDataSource]: https://google.github.io/ExoPlayer/doc/reference/com/google/android/exoplayer2/upstream/HttpDataSource.html
@@ -53,3 +51,10 @@ new DefaultDataSourceFactory(
5351
new CronetDataSourceFactory(...) /* baseDataSourceFactory argument */);
5452
```
5553
respectively.
54+
55+
## Links ##
56+
57+
* [Javadoc][]: Classes matching `com.google.android.exoplayer2.ext.cronet.*`
58+
belong to this module.
59+
60+
[Javadoc]: https://google.github.io/ExoPlayer/doc/reference/index.html

Diff for: extensions/ffmpeg/README.md

+7-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# ExoPlayer FFmpeg extension #
22

3-
## Description ##
4-
53
The FFmpeg extension provides `FfmpegAudioRenderer`, which uses FFmpeg for
64
decoding and can render audio encoded in a variety of formats.
75

@@ -140,3 +138,10 @@ then implement your own logic to use the renderer for a given track.
140138
[Android NDK]: https://developer.android.com/tools/sdk/ndk/index.html
141139
[#2781]: https://github.com/google/ExoPlayer/issues/2781
142140
[Supported formats]: https://google.github.io/ExoPlayer/supported-formats.html#ffmpeg-extension
141+
142+
## Links ##
143+
144+
* [Javadoc][]: Classes matching `com.google.android.exoplayer2.ext.ffmpeg.*`
145+
belong to this module.
146+
147+
[Javadoc]: https://google.github.io/ExoPlayer/doc/reference/index.html

Diff for: extensions/flac/README.md

+7-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# ExoPlayer Flac extension #
22

3-
## Description ##
4-
53
The Flac extension provides `FlacExtractor` and `LibflacAudioRenderer`, which
64
use libFLAC (the Flac decoding library) to extract and decode FLAC audio.
75

@@ -82,3 +80,10 @@ Note: These instructions assume you're using `DefaultTrackSelector`. If you have
8280
a custom track selector the choice of `Renderer` is up to your implementation,
8381
so you need to make sure you are passing an `LibflacAudioRenderer` to the
8482
player, then implement your own logic to use the renderer for a given track.
83+
84+
## Links ##
85+
86+
* [Javadoc][]: Classes matching `com.google.android.exoplayer2.ext.flac.*`
87+
belong to this module.
88+
89+
[Javadoc]: https://google.github.io/ExoPlayer/doc/reference/index.html

Diff for: extensions/gvr/README.md

+12-6
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# ExoPlayer GVR extension #
22

3-
## Description ##
4-
53
The GVR extension wraps the [Google VR SDK for Android][]. It provides a
64
GvrAudioProcessor, which uses [GvrAudioSurround][] to provide binaural rendering
75
of surround sound and ambisonic soundfields.
@@ -26,9 +24,17 @@ locally. Instructions for doing this can be found in ExoPlayer's
2624

2725
## Using the extension ##
2826

29-
* If using SimpleExoPlayer, override SimpleExoPlayer.buildAudioProcessors to
30-
return a GvrAudioProcessor.
31-
* If constructing renderers directly, pass a GvrAudioProcessor to
32-
MediaCodecAudioRenderer's constructor.
27+
* If using `DefaultRenderersFactory`, override
28+
`DefaultRenderersFactory.buildAudioProcessors` to return a
29+
`GvrAudioProcessor`.
30+
* If constructing renderers directly, pass a `GvrAudioProcessor` to
31+
`MediaCodecAudioRenderer`'s constructor.
3332

3433
[top level README]: https://github.com/google/ExoPlayer/blob/release-v2/README.md
34+
35+
## Links ##
36+
37+
* [Javadoc][]: Classes matching `com.google.android.exoplayer2.ext.gvr.*`
38+
belong to this module.
39+
40+
[Javadoc]: https://google.github.io/ExoPlayer/doc/reference/index.html

Diff for: extensions/ima/README.md

+7-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# ExoPlayer IMA extension #
22

3-
## Description ##
4-
53
The IMA extension is a [MediaSource][] implementation wrapping the
64
[Interactive Media Ads SDK for Android][IMA]. You can use it to insert ads
75
alongside content.
@@ -55,3 +53,10 @@ playback.
5553

5654
[top level README]: https://github.com/google/ExoPlayer/blob/release-v2/README.md
5755
[sample ad tags]: https://developers.google.com/interactive-media-ads/docs/sdks/android/tags
56+
57+
## Links ##
58+
59+
* [Javadoc][]: Classes matching `com.google.android.exoplayer2.ext.ima.*`
60+
belong to this module.
61+
62+
[Javadoc]: https://google.github.io/ExoPlayer/doc/reference/index.html

Diff for: extensions/mediasession/README.md

+7-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# ExoPlayer MediaSession extension #
22

3-
## Description ##
4-
53
The MediaSession extension mediates between a Player (or ExoPlayer) instance
64
and a [MediaSession][]. It automatically retrieves and implements playback
75
actions and syncs the player state with the state of the media session. The
@@ -25,3 +23,10 @@ locally. Instructions for doing this can be found in ExoPlayer's
2523
[top level README][].
2624

2725
[top level README]: https://github.com/google/ExoPlayer/blob/release-v2/README.md
26+
27+
## Links ##
28+
29+
* [Javadoc][]: Classes matching
30+
`com.google.android.exoplayer2.ext.mediasession.*` belong to this module.
31+
32+
[Javadoc]: https://google.github.io/ExoPlayer/doc/reference/index.html

Diff for: extensions/okhttp/README.md

+7-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# ExoPlayer OkHttp extension #
22

3-
## Description ##
4-
53
The OkHttp extension is an [HttpDataSource][] implementation using Square's
64
[OkHttp][].
75

@@ -49,3 +47,10 @@ new DefaultDataSourceFactory(
4947
new OkHttpDataSourceFactory(...) /* baseDataSourceFactory argument */);
5048
```
5149
respectively.
50+
51+
## Links ##
52+
53+
* [Javadoc][]: Classes matching `com.google.android.exoplayer2.ext.okhttp.*`
54+
belong to this module.
55+
56+
[Javadoc]: https://google.github.io/ExoPlayer/doc/reference/index.html

Diff for: extensions/opus/README.md

+9-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
# ExoPlayer Opus extension #
22

3-
## Description ##
4-
5-
The Opus extension provides `LibopusAudioRenderer`, which uses
6-
libopus (the Opus decoding library) to decode Opus audio.
3+
The Opus extension provides `LibopusAudioRenderer`, which uses libopus (the Opus
4+
decoding library) to decode Opus audio.
75

86
## Build instructions ##
97

@@ -86,3 +84,10 @@ Note: These instructions assume you're using `DefaultTrackSelector`. If you have
8684
a custom track selector the choice of `Renderer` is up to your implementation,
8785
so you need to make sure you are passing an `LibopusAudioRenderer` to the
8886
player, then implement your own logic to use the renderer for a given track.
87+
88+
## Links ##
89+
90+
* [Javadoc][]: Classes matching `com.google.android.exoplayer2.ext.opus.*`
91+
belong to this module.
92+
93+
[Javadoc]: https://google.github.io/ExoPlayer/doc/reference/index.html

Diff for: extensions/rtmp/README.md

+7-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# ExoPlayer RTMP extension #
22

3-
## Description ##
4-
53
The RTMP extension is a [DataSource][] implementation for playing [RTMP][]
64
streams using [LibRtmp Client for Android][].
75

@@ -41,3 +39,10 @@ application code are required. Alternatively, if you know that your application
4139
doesn't need to handle any other protocols, you can update any `DataSource`s and
4240
`DataSource.Factory` instantiations in your application code to use
4341
`RtmpDataSource` and `RtmpDataSourceFactory` directly.
42+
43+
## Links ##
44+
45+
* [Javadoc][]: Classes matching `com.google.android.exoplayer2.ext.rtmp.*`
46+
belong to this module.
47+
48+
[Javadoc]: https://google.github.io/ExoPlayer/doc/reference/index.html

Diff for: extensions/vp9/README.md

+9-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
# ExoPlayer VP9 extension #
22

3-
## Description ##
4-
5-
The VP9 extension provides `LibvpxVideoRenderer`, which uses
6-
libvpx (the VPx decoding library) to decode VP9 video.
3+
The VP9 extension provides `LibvpxVideoRenderer`, which uses libvpx (the VPx
4+
decoding library) to decode VP9 video.
75

86
## Build instructions ##
97

@@ -110,3 +108,10 @@ performed using a GL shader. To enable this mode, send the renderer a message of
110108
type `LibvpxVideoRenderer.MSG_SET_OUTPUT_BUFFER_RENDERER` with the
111109
`VpxVideoSurfaceView` as its object, instead of sending `MSG_SET_SURFACE` with a
112110
`Surface`.
111+
112+
## Links ##
113+
114+
* [Javadoc][]: Classes matching `com.google.android.exoplayer2.ext.vp9.*`
115+
belong to this module.
116+
117+
[Javadoc]: https://google.github.io/ExoPlayer/doc/reference/index.html

Diff for: library/README.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# ExoPlayer library #
2+
3+
The ExoPlayer library is split into multiple modules. See ExoPlayer's
4+
[top level README][] for more information about the available library modules
5+
and how to use them.
6+
7+
[top level README]: https://github.com/google/ExoPlayer/blob/release-v2/README.md

Diff for: library/all/README.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# ExoPlayer full library #
2+
3+
An empty module that depends on all of the other library modules. Depending on
4+
the full library is equivalent to depending on all of the other library modules
5+
individually. See ExoPlayer's [top level README][] for more information.
6+
7+
[top level README]: https://github.com/google/ExoPlayer/blob/release-v2/README.md
8+
9+
## Links ##
10+
11+
* [Javadoc][]: Note that this Javadoc is combined with that of other modules.
12+
13+
[Javadoc]: https://google.github.io/ExoPlayer/doc/reference/index.html

Diff for: library/core/README.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# ExoPlayer core library module #
2+
3+
The core of the ExoPlayer library.
4+
5+
## Links ##
6+
7+
* [Javadoc][]: Note that this Javadoc is combined with that of other modules.
8+
9+
[Javadoc]: https://google.github.io/ExoPlayer/doc/reference/index.html

Diff for: library/dash/README.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# ExoPlayer DASH library module #
2+
3+
Provides support for Dynamic Adaptive Streaming over HTTP (DASH) content. To
4+
play DASH content, instantiate a `DashMediaSource` and pass it to
5+
`ExoPlayer.prepare`.
6+
7+
## Links ##
8+
9+
* [Javadoc][]: Classes matching `com.google.android.exoplayer2.source.dash.*`
10+
belong to this module.
11+
12+
[Javadoc]: https://google.github.io/ExoPlayer/doc/reference/index.html

Diff for: library/hls/README.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# ExoPlayer HLS library module #
2+
3+
Provides support for HTTP Live Streaming (HLS) content. To play HLS content,
4+
instantiate a `HlsMediaSource` and pass it to `ExoPlayer.prepare`.
5+
6+
## Links ##
7+
8+
* [Javadoc][]: Classes matching `com.google.android.exoplayer2.source.hls.*`
9+
belong to this module.
10+
11+
[Javadoc]: https://google.github.io/ExoPlayer/doc/reference/index.html

Diff for: library/smoothstreaming/README.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# ExoPlayer SmoothStreaming library module #
2+
3+
Provides support for Smooth Streaming content. To play Smooth Streaming content,
4+
instantiate a `SsMediaSource` and pass it to `ExoPlayer.prepare`.
5+
6+
## Links ##
7+
8+
* [Javadoc][]: Classes matching
9+
`com.google.android.exoplayer2.source.smoothstreaming.*` belong to this
10+
module.
11+
12+
[Javadoc]: https://google.github.io/ExoPlayer/doc/reference/index.html

0 commit comments

Comments
 (0)