README.md
1# ExoPlayer RTSP module
2
3Provides support for RTSP playbacks 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-rtsp: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
21## Using the module
22
23Adding a dependency to this module is all that's required to enable playback of
24RTSP media items added to `ExoPlayer` in its default configuration. Internally,
25`DefaultMediaSourceFactory` will automatically detect the presence of the module
26and convert a RTSP `MediaItem` into a `RtspMediaSource` for playback.
27
28For advanced playback use cases, applications can build `RtspMediaSource`
29instances and pass them directly to the player.
30
31## Links
32
33* [Developer Guide][]
34* [Javadoc][]
35
36[Developer Guide]: https://exoplayer.dev/dash.html
37[Javadoc]: https://exoplayer.dev/doc/reference/index.html
38