diff --git a/demos/cast/README.md b/demos/cast/README.md index 84c4bae8d1..b636d2c2e0 100644 --- a/demos/cast/README.md +++ b/demos/cast/README.md @@ -1,7 +1,7 @@ -# Cast demo application +# Cast demo -This folder contains a demo application that showcases ExoPlayer integration -with Google Cast. +This app demonstrates integration with Google Cast, as well as switching between +Google Cast and local playback using ExoPlayer. -Please see the [demos README](../README.md) for instructions on how to build and -run this demo. +See the [demos README](../README.md) for instructions on how to build and run +this demo. diff --git a/demos/main/README.md b/demos/main/README.md index 0d9eb28cf9..91aa2742bf 100644 --- a/demos/main/README.md +++ b/demos/main/README.md @@ -1,8 +1,8 @@ # ExoPlayer main demo -This is the main ExoPlayer demo application. It uses ExoPlayer to play a number -of test streams. It can be used as a starting point or reference project when -developing other applications that make use of the ExoPlayer library. +This is the main ExoPlayer demo app. It uses ExoPlayer to play a number of test +streams. It can be used as a starting point or reference project when developing +other applications that make use of the ExoPlayer library. -Please see the [demos README](../README.md) for instructions on how to build and -run this demo. +See the [demos README](../README.md) for instructions on how to build and run +this demo. diff --git a/demos/surface/README.md b/demos/surface/README.md index 3febb23feb..496e1b4931 100644 --- a/demos/surface/README.md +++ b/demos/surface/README.md @@ -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 doesn't handle protected output on all devices). -Please see the [demos README](../README.md) for instructions on how to build and -run this demo. +See the [demos README](../README.md) for instructions on how to build and run +this demo. [SurfaceControl]: https://developer.android.com/reference/android/view/SurfaceControl diff --git a/library/common/README.md b/library/common/README.md index 9e78e273b6..f2f8e2cca9 100644 --- a/library/common/README.md +++ b/library/common/README.md @@ -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 * [Javadoc][]: Note that this Javadoc is combined with that of other modules. [Javadoc]: https://exoplayer.dev/doc/reference/index.html - diff --git a/library/extractor/README.md b/library/extractor/README.md index fa2a23ee20..f7aaad1e4c 100644 --- a/library/extractor/README.md +++ b/library/extractor/README.md @@ -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 diff --git a/library/transformer/README.md b/library/transformer/README.md index 6cba7c60a7..0d7ba4f0d1 100644 --- a/library/transformer/README.md +++ b/library/transformer/README.md @@ -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 -* [Javadoc][]: Classes matching `com.google.android.exoplayer2.transformer.*` - belong to this module. +* [Javadoc][]: Classes matching `com.google.android.exoplayer2.transformer.*` belong to this + module. [Javadoc]: https://exoplayer.dev/doc/reference/index.html