Skip to content

SDK / exoplayer

Go to a project
Commit 636a4a85 by ibaker Committed by Ian Baker
Options

Add javadoc links to README files 

Fix some other link titles and destinations spotted along the way.

#minor-release

PiperOrigin-RevId: 493276172
parent ac0d8030
Inline Side-by-side
Showing with 176 additions and 3 deletions
libraries/cast/README.md
...@@ -27,3 +27,9 @@ Create a `CastPlayer` and use it to control a Cast receiver app. Since ...@@ -27,3 +27,9 @@ Create a `CastPlayer` and use it to control a Cast receiver app. Since
`CastPlayer` implements the `Player` interface, it can be passed to all media `CastPlayer` implements the `Player` interface, it can be passed to all media
components that accept a `Player`, including the UI components provided by the components that accept a `Player`, including the UI components provided by the
UI module. UI module.
## Links
* [Javadoc][]
[Javadoc]: https://developer.android.com/reference/androidx/media3/packages
libraries/common/README.md
...@@ -2,3 +2,9 @@ ...@@ -2,3 +2,9 @@
Provides common code and utilities used by other media modules. Application code Provides common code and utilities used by other media modules. Application code
will not normally need to depend on this module directly. will not normally need to depend on this module directly.
## Links
* [Javadoc][]
[Javadoc]: https://developer.android.com/reference/androidx/media3/packages
libraries/database/README.md
...@@ -5,7 +5,6 @@ will not normally need to depend on this module directly. ...@@ -5,7 +5,6 @@ will not normally need to depend on this module directly.
## Links ## Links
* [Javadoc][]: Classes matching `androidx.media3.database.*` belong to this * [Javadoc][]
module.
[Javadoc]: https://exoplayer.dev/doc/reference/index.html [Javadoc]: https://developer.android.com/reference/androidx/media3/packages
libraries/datasource/README.md
...@@ -3,3 +3,9 @@ ...@@ -3,3 +3,9 @@
Provides a `DataSource` abstraction and a number of concrete implementations for Provides a `DataSource` abstraction and a number of concrete implementations for
reading data from different sources. Application code will not normally need to reading data from different sources. Application code will not normally need to
depend on this module directly. depend on this module directly.
## Links
* [Javadoc][]
[Javadoc]: https://developer.android.com/reference/androidx/media3/packages
libraries/datasource_cronet/README.md
...@@ -119,3 +119,9 @@ whilst still using Cronet Fallback for other networking performed by your ...@@ -119,3 +119,9 @@ whilst still using Cronet Fallback for other networking performed by your
application. application.
[Send a simple request]: https://developer.android.com/guide/topics/connectivity/cronet/start [Send a simple request]: https://developer.android.com/guide/topics/connectivity/cronet/start
## Links
* [Javadoc][]
[Javadoc]: https://developer.android.com/reference/androidx/media3/packages
libraries/datasource_okhttp/README.md
...@@ -48,3 +48,9 @@ new DefaultDataSourceFactory( ...@@ -48,3 +48,9 @@ new DefaultDataSourceFactory(
... ...
/* baseDataSourceFactory= */ new OkHttpDataSource.Factory(...)); /* baseDataSourceFactory= */ new OkHttpDataSource.Factory(...));
``` ```
## Links
* [Javadoc][]
[Javadoc]: https://developer.android.com/reference/androidx/media3/packages
libraries/datasource_rtmp/README.md
...@@ -45,3 +45,9 @@ application code are required. Alternatively, if you know that your application ...@@ -45,3 +45,9 @@ application code are required. Alternatively, if you know that your application
doesn't need to handle any other protocols, you can update any doesn't need to handle any other protocols, you can update any
`DataSource.Factory` instantiations in your application code to use `DataSource.Factory` instantiations in your application code to use
`RtmpDataSource.Factory` directly. `RtmpDataSource.Factory` directly.
## Links
* [Javadoc][]
[Javadoc]: https://developer.android.com/reference/androidx/media3/packages
libraries/decoder/README.md
...@@ -2,3 +2,9 @@ ...@@ -2,3 +2,9 @@
Provides a decoder abstraction. Application code will not normally need to Provides a decoder abstraction. Application code will not normally need to
depend on this module directly. depend on this module directly.
## Links
* [Javadoc][]
[Javadoc]: https://developer.android.com/reference/androidx/media3/packages
libraries/decoder_av1/README.md
...@@ -123,3 +123,11 @@ gets from the libgav1 decoder: ...@@ -123,3 +123,11 @@ gets from the libgav1 decoder:
Note: Although the default option uses `ANativeWindow`, based on our testing the Note: Although the default option uses `ANativeWindow`, based on our testing the
GL rendering mode has better performance, so should be preferred GL rendering mode has better performance, so should be preferred
## Links
<!-- TODO(b/204738828): Add link to 'troubleshooting using decoding extensions' media3 guide entry when it's published on developer.android.com -->
* [Javadoc][]
[Javadoc]: https://developer.android.com/reference/androidx/media3/packages
libraries/decoder_ffmpeg/README.md
...@@ -116,3 +116,11 @@ then implement your own logic to use the renderer for a given track. ...@@ -116,3 +116,11 @@ then implement your own logic to use the renderer for a given track.
[Android NDK]: https://developer.android.com/tools/sdk/ndk/index.html [Android NDK]: https://developer.android.com/tools/sdk/ndk/index.html
[ExoPlayer issue 2781]: https://github.com/google/ExoPlayer/issues/2781 [ExoPlayer issue 2781]: https://github.com/google/ExoPlayer/issues/2781
[Supported formats]: https://exoplayer.dev/supported-formats.html#ffmpeg-extension [Supported formats]: https://exoplayer.dev/supported-formats.html#ffmpeg-extension
## Links
<!-- TODO(b/204738828): Add link to 'troubleshooting using extensions' media3 guide entry when it's published on developer.android.com -->
* [Javadoc][]
[Javadoc]: https://developer.android.com/reference/androidx/media3/packages
libraries/decoder_flac/README.md
...@@ -95,3 +95,11 @@ Note: These instructions assume you're using `DefaultTrackSelector`. If you have ...@@ -95,3 +95,11 @@ Note: These instructions assume you're using `DefaultTrackSelector`. If you have
a custom track selector the choice of `Renderer` is up to your implementation, a custom track selector the choice of `Renderer` is up to your implementation,
so you need to make sure you are passing an `LibflacAudioRenderer` to the so you need to make sure you are passing an `LibflacAudioRenderer` to the
player, then implement your own logic to use the renderer for a given track. player, then implement your own logic to use the renderer for a given track.
## Links
<!-- TODO(b/204738828): Add link to 'troubleshooting decoding using extensions' media3 guide entry when it's published on developer.android.com -->
* [Javadoc][]
[Javadoc]: https://developer.android.com/reference/androidx/media3/packages
libraries/decoder_opus/README.md
...@@ -99,3 +99,11 @@ Note: These instructions assume you're using `DefaultTrackSelector`. If you have ...@@ -99,3 +99,11 @@ Note: These instructions assume you're using `DefaultTrackSelector`. If you have
a custom track selector the choice of `Renderer` is up to your implementation, a custom track selector the choice of `Renderer` is up to your implementation,
so you need to make sure you are passing an `LibopusAudioRenderer` to the so you need to make sure you are passing an `LibopusAudioRenderer` to the
player, then implement your own logic to use the renderer for a given track. player, then implement your own logic to use the renderer for a given track.
## Links
<!-- TODO(b/204738828): Add link to 'troubleshooting using decoding extensions' media3 guide entry when it's published on developer.android.com -->
* [Javadoc][]
[Javadoc]: https://developer.android.com/reference/androidx/media3/packages
libraries/decoder_vp9/README.md
...@@ -136,3 +136,11 @@ gets from the libvpx decoder: ...@@ -136,3 +136,11 @@ gets from the libvpx decoder:
Note: Although the default option uses `ANativeWindow`, based on our testing the Note: Although the default option uses `ANativeWindow`, based on our testing the
GL rendering mode has better performance, so should be preferred. GL rendering mode has better performance, so should be preferred.
## Links
<!-- TODO(b/204738828): Add link to 'troubleshooting using decoding extensions' media3 guide entry when it's published on developer.android.com -->
* [Javadoc][]
[Javadoc]: https://developer.android.com/reference/androidx/media3/packages
libraries/effect/README.md
...@@ -17,3 +17,9 @@ Alternatively, you can clone this GitHub project and depend on the module ...@@ -17,3 +17,9 @@ 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][]. locally. Instructions for doing this can be found in the [top level README][].
[top level README]: ../../README.md [top level README]: ../../README.md
## Links
* [Javadoc][]
[Javadoc]: https://developer.android.com/reference/androidx/media3/packages
libraries/exoplayer/README.md
...@@ -18,3 +18,9 @@ Alternatively, you can clone this GitHub project and depend on the module ...@@ -18,3 +18,9 @@ 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][]. locally. Instructions for doing this can be found in the [top level README][].
[top level README]: ../../README.md [top level README]: ../../README.md
## Links
* [Javadoc][]
[Javadoc]: https://developer.android.com/reference/androidx/media3/packages
libraries/exoplayer_dash/README.md
...@@ -33,3 +33,11 @@ the module and build `DashDownloader` instances to download DASH content. ...@@ -33,3 +33,11 @@ the module and build `DashDownloader` instances to download DASH content.
For advanced playback use cases, applications can build `DashMediaSource` For advanced playback use cases, applications can build `DashMediaSource`
instances and pass them directly to the player. For advanced download use cases, instances and pass them directly to the player. For advanced download use cases,
`DashDownloader` can be used directly. `DashDownloader` can be used directly.
## Links
<!-- TODO(b/204738828): Add link to DASH media3 guide entry when it's published on developer.android.com -->
* [Javadoc][]
[Javadoc]: https://developer.android.com/reference/androidx/media3/packages
libraries/exoplayer_hls/README.md
...@@ -32,3 +32,11 @@ the module and build `HlsDownloader` instances to download HLS content. ...@@ -32,3 +32,11 @@ the module and build `HlsDownloader` instances to download HLS content.
For advanced playback use cases, applications can build `HlsMediaSource` For advanced playback use cases, applications can build `HlsMediaSource`
instances and pass them directly to the player. For advanced download use cases, instances and pass them directly to the player. For advanced download use cases,
`HlsDownloader` can be used directly. `HlsDownloader` can be used directly.
## Links
<!-- TODO(b/204738828): Add link to HLS media3 guide entry when it's published on developer.android.com -->
* [Javadoc][]
[Javadoc]: https://developer.android.com/reference/androidx/media3/packages
libraries/exoplayer_ima/README.md
...@@ -49,3 +49,11 @@ You can try the IMA module in the ExoPlayer demo app, which has test content in ...@@ -49,3 +49,11 @@ You can try the IMA module in the ExoPlayer demo app, which has test content in
the "IMA sample ad tags" section of the sample chooser. The demo app's the "IMA sample ad tags" section of the sample chooser. The demo app's
`PlayerActivity` also shows how to persist the `ImaAdsLoader` instance and the `PlayerActivity` also shows how to persist the `ImaAdsLoader` instance and the
player position when backgrounded during ad playback. player position when backgrounded during ad playback.
## Links
<!-- TODO(b/204738828): Add link to Ad Insertion media3 guide entry when it's published on developer.android.com -->
* [Javadoc][]
[Javadoc]: https://developer.android.com/reference/androidx/media3/packages
libraries/exoplayer_rtsp/README.md
...@@ -27,3 +27,11 @@ and convert a RTSP `MediaItem` into a `RtspMediaSource` for playback. ...@@ -27,3 +27,11 @@ and convert a RTSP `MediaItem` into a `RtspMediaSource` for playback.
For advanced playback use cases, applications can build `RtspMediaSource` For advanced playback use cases, applications can build `RtspMediaSource`
instances and pass them directly to the player. instances and pass them directly to the player.
## Links
<!-- TODO(b/204738828): Add link to RTSP media3 guide entry when it's published on developer.android.com -->
* [Javadoc][]
[Javadoc]: https://developer.android.com/reference/androidx/media3/packages
libraries/exoplayer_smoothstreaming/README.md
...@@ -32,3 +32,11 @@ content. ...@@ -32,3 +32,11 @@ content.
For advanced playback use cases, applications can build `SsMediaSource` For advanced playback use cases, applications can build `SsMediaSource`
instances and pass them directly to the player. For advanced download use cases, instances and pass them directly to the player. For advanced download use cases,
`SsDownloader` can be used directly. `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
libraries/exoplayer_workmanager/README.md
...@@ -19,3 +19,9 @@ Alternatively, you can clone this GitHub project and depend on the module ...@@ -19,3 +19,9 @@ 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][]. locally. Instructions for doing this can be found in the [top level README][].
[top level README]: ../../README.md [top level README]: ../../README.md
## Links
* [Javadoc][]
[Javadoc]: https://developer.android.com/reference/androidx/media3/packages
libraries/extractor/README.md
...@@ -2,3 +2,9 @@ ...@@ -2,3 +2,9 @@
Provides media container extractors and related utilities. Application code will Provides media container extractors and related utilities. Application code will
not normally need to depend on this module directly. not normally need to depend on this module directly.
## Links
* [Javadoc][]
[Javadoc]: https://developer.android.com/reference/androidx/media3/packages
libraries/test_utils/README.md
# Test utils module # Test utils module
Provides utility classes for media unit and instrumentation tests. Provides utility classes for media unit and instrumentation tests.
## Links
* [Javadoc][]
[Javadoc]: https://developer.android.com/reference/androidx/media3/packages
libraries/test_utils_robolectric/README.md
# Robolectric test utils module # Robolectric test utils module
Provides test infrastructure for Robolectric-based media tests. Provides test infrastructure for Robolectric-based media tests.
## Links
* [Javadoc][]
[Javadoc]: https://developer.android.com/reference/androidx/media3/packages
libraries/transformer/README.md
...@@ -17,3 +17,11 @@ Alternatively, you can clone this GitHub project and depend on the module ...@@ -17,3 +17,11 @@ 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][]. locally. Instructions for doing this can be found in the [top level README][].
[top level README]: ../../README.md [top level README]: ../../README.md
## Links
<!-- TODO(b/204738828): Add link to Transformer media3 guide entry when it's published on developer.android.com -->
* [Javadoc][]
[Javadoc]: https://developer.android.com/reference/androidx/media3/packages
libraries/ui/README.md
...@@ -17,3 +17,11 @@ Alternatively, you can clone this GitHub project and depend on the module ...@@ -17,3 +17,11 @@ 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][]. locally. Instructions for doing this can be found in the [top level README][].
[top level README]: ../../README.md [top level README]: ../../README.md
## Links
<!-- TODO(b/204738828): Add link to UI media3 guide entry when it's published on developer.android.com -->
* [Javadoc][]
[Javadoc]: https://developer.android.com/reference/androidx/media3/packages
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or sign in to comment