README updates for misc modules

PiperOrigin-RevId: 402292139
This commit is contained in:
olly 2021-10-11 15:29:36 +01:00 committed by Oliver Woodman
parent b7d53fa4b2
commit 8a9dcadef3
6 changed files with 43 additions and 21 deletions

View File

@ -1,7 +1,7 @@
# Cast demo application # Cast demo
This folder contains a demo application that showcases ExoPlayer integration This app demonstrates integration with Google Cast, as well as switching between
with Google Cast. Google Cast and local playback using ExoPlayer.
Please see the [demos README](../README.md) for instructions on how to build and See the [demos README](../README.md) for instructions on how to build and run
run this demo. this demo.

View File

@ -1,8 +1,8 @@
# ExoPlayer main demo # ExoPlayer main demo
This is the main ExoPlayer demo application. It uses ExoPlayer to play a number This is the main ExoPlayer demo app. It uses ExoPlayer to play a number of test
of test streams. It can be used as a starting point or reference project when streams. It can be used as a starting point or reference project when developing
developing other applications that make use of the ExoPlayer library. other applications that make use of the ExoPlayer library.
Please see the [demos README](../README.md) for instructions on how to build and See the [demos README](../README.md) for instructions on how to build and run
run this demo. this demo.

View File

@ -18,7 +18,7 @@ called, and because you can move output off-screen easily (`setOutputSurface`
can't take a `null` surface, so the player has to use a `DummySurface`, which can't take a `null` surface, so the player has to use a `DummySurface`, which
doesn't handle protected output on all devices). doesn't handle protected output on all devices).
Please see the [demos README](../README.md) for instructions on how to build and See the [demos README](../README.md) for instructions on how to build and run
run this demo. this demo.
[SurfaceControl]: https://developer.android.com/reference/android/view/SurfaceControl [SurfaceControl]: https://developer.android.com/reference/android/view/SurfaceControl

View File

@ -1,10 +1,10 @@
# ExoPlayer common library module # Common module
Common code used by other ExoPlayer modules. Provides common code and utilities used by other media modules. Application code
will not normally need to depend on this module directly.
## Links ## Links
* [Javadoc][]: Note that this Javadoc is combined with that of other modules. * [Javadoc][]: Note that this Javadoc is combined with that of other modules.
[Javadoc]: https://exoplayer.dev/doc/reference/index.html [Javadoc]: https://exoplayer.dev/doc/reference/index.html

View File

@ -1,6 +1,7 @@
# ExoPlayer extractor library module # Extractor module
Provides media container extractors. Provides media container extractors and related utilities. Application code will
not normally need to depend on this module directly.
## Links ## Links

View File

@ -1,10 +1,31 @@
# ExoPlayer transformer library module # Transformer module
Provides support for transforming media files. Provides functionality for transforming media files.
## Getting the module
The easiest way to get the module is to add it as a gradle dependency:
```gradle
implementation 'com.google.android.exoplayer:exoplayer-transformer:2.X.X'
```
where `2.X.X` is the version, which must match the version of the other media
modules being used.
Alternatively, you can clone this GitHub project and depend on the module
locally. Instructions for doing this can be found in the [top level README][].
[top level README]: https://github.com/google/ExoPlayer/blob/release-v2/README.md
## Using the module
Use of the Transformer module is documented in the
[developer guide](https://exoplayer.dev/transforming-media.html).
## Links ## Links
* [Javadoc][]: Classes matching `com.google.android.exoplayer2.transformer.*` * [Javadoc][]: Classes matching `com.google.android.exoplayer2.transformer.*` belong to this
belong to this module. module.
[Javadoc]: https://exoplayer.dev/doc/reference/index.html [Javadoc]: https://exoplayer.dev/doc/reference/index.html