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
57 lines
1.8 KiB
Markdown
57 lines
1.8 KiB
Markdown
# OkHttp DataSource module
|
|
|
|
This module provides an [HttpDataSource][] implementation that uses Square's
|
|
[OkHttp][].
|
|
|
|
OkHttp is a modern network stack that's widely used by many popular Android
|
|
applications. It supports the HTTP and HTTP/2 protocols.
|
|
|
|
[HttpDataSource]: ../datasource/src/main/java/androidx/media3/datasource/HttpDataSource.java
|
|
[OkHttp]: https://square.github.io/okhttp/
|
|
|
|
## License note
|
|
|
|
Please note that whilst the code in this repository is licensed under
|
|
[Apache 2.0][], using this extension requires depending on OkHttp, 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-okhttp: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.
|
|
|
|
If your application only needs to play http(s) content, using the OkHttp
|
|
extension is as simple as updating any `DataSource.Factory` instantiations in
|
|
your application code to use `OkHttpDataSource.Factory`. If your application
|
|
also needs to play non-http(s) content such as local files, use:
|
|
```
|
|
new DefaultDataSourceFactory(
|
|
...
|
|
/* baseDataSourceFactory= */ new OkHttpDataSource.Factory(...));
|
|
```
|
|
|
|
## Links
|
|
|
|
* [Javadoc][]
|
|
|
|
[Javadoc]: https://developer.android.com/reference/androidx/media3/datasource/okhttp/package-summary
|