ibaker 3df6949c52 Add javadoc links to README files
Fix some other link titles and destinations spotted along the way.

#minor-release

PiperOrigin-RevId: 493276172
(cherry picked from commit 636a4a8538ccfb235eeca7d9131d4b5d4d95e9aa)
2023-01-25 18:01:21 +00:00

43 lines
1.5 KiB
Markdown

# ExoPlayer SmoothStreaming module
Provides support for SmoothStreaming content in ExoPlayer.
## Getting the module
The easiest way to get the module is to add it as a gradle dependency:
```gradle
implementation 'androidx.media3:media3-exoplayer-smoothstreaming:1.X.X'
```
where `1.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]: ../../README.md
Adding a dependency to this module is all that's required to enable playback of
SmoothStreaming media items added to `ExoPlayer` in its default configuration.
Internally, `DefaultMediaSourceFactory` will automatically detect the presence
of the module and convert a SmoothStreaming `MediaItem` into a `SsMediaSource`
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
<!-- TODO(b/204738828): Add link to SmoothStreaming media3 guide entry when it's published on developer.android.com -->
* [Javadoc][]
[Javadoc]: https://developer.android.com/reference/androidx/media3/packages