6a928805d4
Also fixed the javadoc link in devsite and removed javadoc links from decoder extensions as it is not published yet on developer.android.com. #minor-release PiperOrigin-RevId: 520636868
54 lines
1.9 KiB
Markdown
54 lines
1.9 KiB
Markdown
# RTMP DataSource module
|
|
|
|
This module provides a [DataSource][] implementation for requesting [RTMP][]
|
|
streams using [LibRtmp Client for Android][].
|
|
|
|
[DataSource]: ../datasource/src/main/java/androidx/media3/datasource/DataSource.java
|
|
[RTMP]: https://en.wikipedia.org/wiki/Real-Time_Messaging_Protocol
|
|
[LibRtmp Client for Android]: https://github.com/ant-media/LibRtmp-Client-for-Android
|
|
|
|
## License note
|
|
|
|
Please note that whilst the code in this repository is licensed under
|
|
[Apache 2.0][], using this extension requires depending on LibRtmp Client for
|
|
Android, which is licensed separately.
|
|
|
|
[Apache 2.0]: ../../LICENSE
|
|
|
|
## Getting the module
|
|
|
|
The easiest way to get the module is to add it as a gradle dependency:
|
|
|
|
```gradle
|
|
implementation 'androidx.media3:media3-datasource-rtmp: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
|
|
|
|
## Using the module
|
|
|
|
Media components request data through `DataSource` instances. These instances
|
|
are obtained from instances of `DataSource.Factory`, which are instantiated and
|
|
injected from application code.
|
|
|
|
`DefaultDataSource` will automatically use the RTMP extension whenever it's
|
|
available. Hence if your application is using `DefaultDataSource` or
|
|
`DefaultDataSource.Factory`, adding support for RTMP streams is as simple as
|
|
adding a dependency to the RTMP extension as described above. No changes to your
|
|
application code are required. Alternatively, if you know that your application
|
|
doesn't need to handle any other protocols, you can update any
|
|
`DataSource.Factory` instantiations in your application code to use
|
|
`RtmpDataSource.Factory` directly.
|
|
|
|
## Links
|
|
|
|
* [Javadoc][]
|
|
|
|
[Javadoc]: https://developer.android.com/reference/androidx/media3/datasource/rtmp/package-summary
|