README.md
1# ExoPlayer SmoothStreaming module
2
3Provides support for SmoothStreaming content in ExoPlayer.
4
5## Getting the module
6
7The easiest way to get the module is to add it as a gradle dependency:
8
9```gradle
10implementation 'com.google.android.exoplayer:exoplayer-smoothstreaming:2.X.X'
11```
12
13where `2.X.X` is the version, which must match the version of the other media
14modules being used.
15
16Alternatively, you can clone this GitHub project and depend on the module
17locally. Instructions for doing this can be found in the [top level README][].
18
19[top level README]: https://github.com/google/ExoPlayer/blob/release-v2/README.md
20
21Adding a dependency to this module is all that's required to enable playback of
22SmoothStreaming media items added to `ExoPlayer` in its default configuration.
23Internally, `DefaultMediaSourceFactory` will automatically detect the presence
24of the module and convert a SmoothStreaming `MediaItem` into a `SsMediaSource`
25for playback.
26
27Similarly, a `DownloadManager` in its default configuration will use
28`DefaultDownloaderFactory`, which will automatically detect the presence of
29the module and build `SsDownloader` instances to download SmoothStreaming
30content.
31
32For advanced playback use cases, applications can build `SsMediaSource`
33instances and pass them directly to the player. For advanced download use cases,
34`SsDownloader` can be used directly.
35
36## Links
37
38* [Developer Guide][]
39* [Javadoc][]
40
41[Developer Guide]: https://exoplayer.dev/smoothstreaming.html
42[Javadoc]: https://exoplayer.dev/doc/reference/index.html
43