From fd71e38db3cc06a28b7cc887f75a6eda60976ddd Mon Sep 17 00:00:00 2001 From: olly Date: Wed, 2 Sep 2020 19:24:44 +0100 Subject: [PATCH] Fix DASH/SS/HLS module readme files PiperOrigin-RevId: 329751934 --- library/dash/README.md | 18 +++++++++++++++--- library/hls/README.md | 17 +++++++++++++++-- library/smoothstreaming/README.md | 18 ++++++++++++++++-- 3 files changed, 46 insertions(+), 7 deletions(-) diff --git a/library/dash/README.md b/library/dash/README.md index 1076716684..2ae77c41aa 100644 --- a/library/dash/README.md +++ b/library/dash/README.md @@ -1,8 +1,20 @@ # ExoPlayer DASH library module # -Provides support for Dynamic Adaptive Streaming over HTTP (DASH) content. To -play DASH content, instantiate a `DashMediaSource` and pass it to -`ExoPlayer.prepare`. +Provides support for Dynamic Adaptive Streaming over HTTP (DASH) content. + +Adding a dependency to this module is all that's required to enable playback of +DASH `MediaItem`s added to an `ExoPlayer` or `SimpleExoPlayer` in their default +configurations. Internally, `DefaultMediaSourceFactory` will automatically +detect the presence of the module and convert DASH `MediaItem`s into +`DashMediaSource` instances for playback. + +Similarly, a `DownloadManager` in its default configuration will use +`DefaultDownloaderFactory`, which will automatically detect the presence of +the module and build `DashDownloader` instances to download DASH content. + +For advanced playback use cases, applications can build `DashMediaSource` +instances and pass them directly to the player. For advanced download use cases, +`DashDownloader` can be used directly. ## Links ## diff --git a/library/hls/README.md b/library/hls/README.md index 3470c29e3c..b7eecc1ff8 100644 --- a/library/hls/README.md +++ b/library/hls/README.md @@ -1,7 +1,20 @@ # ExoPlayer HLS library module # -Provides support for HTTP Live Streaming (HLS) content. To play HLS content, -instantiate a `HlsMediaSource` and pass it to `ExoPlayer.prepare`. +Provides support for HTTP Live Streaming (HLS) content. + +Adding a dependency to this module is all that's required to enable playback of +HLS `MediaItem`s added to an `ExoPlayer` or `SimpleExoPlayer` in their default +configurations. Internally, `DefaultMediaSourceFactory` will automatically +detect the presence of the module and convert HLS `MediaItem`s into +`HlsMediaSource` instances for playback. + +Similarly, a `DownloadManager` in its default configuration will use +`DefaultDownloaderFactory`, which will automatically detect the presence of +the module and build `HlsDownloader` instances to download HLS content. + +For advanced playback use cases, applications can build `HlsMediaSource` +instances and pass them directly to the player. For advanced download use cases, +`HlsDownloader` can be used directly. ## Links ## diff --git a/library/smoothstreaming/README.md b/library/smoothstreaming/README.md index d53471d17c..2fab69c756 100644 --- a/library/smoothstreaming/README.md +++ b/library/smoothstreaming/README.md @@ -1,7 +1,21 @@ # ExoPlayer SmoothStreaming library module # -Provides support for Smooth Streaming content. To play Smooth Streaming content, -instantiate a `SsMediaSource` and pass it to `ExoPlayer.prepare`. +Provides support for SmoothStreaming content. + +Adding a dependency to this module is all that's required to enable playback of +SmoothStreaming `MediaItem`s added to an `ExoPlayer` or `SimpleExoPlayer` in +their default configurations. Internally, `DefaultMediaSourceFactory` will +automatically detect the presence of the module and convert SmoothStreaming +`MediaItem`s into `SsMediaSource` instances for playback. + +Similarly, a `DownloadManager` in its default configuration will use +`DefaultDownloaderFactory`, which will automatically detect the presence of +the module and build `SsDownloader` instances to download SmoothStreaming +content. + +For advanced playback use cases, applications can build `SsMediaSource` +instances and pass them directly to the player. For advanced download use cases, +`SsDownloader` can be used directly. ## Links ##