Skip to content

Commit

Permalink
Temporarily use exoplayer2-hosted SVGs in media3 javadoc
Browse files Browse the repository at this point in the history
The media3-hosted versions of these SVGs were removed due to a change in
the way the reference docs are generated. While work on getting them
hosted on developer.android.com, this change simply links to the
(identical) exoplayer2 versions in order to fix the media3 docs.

#minor-release

PiperOrigin-RevId: 520647905
  • Loading branch information
icbaker authored and tianyif committed Mar 30, 2023
1 parent 6a92880 commit 2e4f49f
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 18 deletions.
37 changes: 23 additions & 14 deletions libraries/common/src/main/java/androidx/media3/common/Timeline.java
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,9 @@
*
* <h2 id="single-file">Single media file or on-demand stream</h2>
*
* <p style="align:center"><img src="doc-files/timeline-single-file.svg" alt="Example timeline for a
* single file">
* <p style="align:center"><img
* src="https://exoplayer.dev/doc/reference/com/google/android/exoplayer2/doc-files/timeline-single-file.svg"
* alt="Example timeline for a single file">
*
* <p>A timeline for a single media file or on-demand stream consists of a single period and window.
* The window spans the whole period, indicating that all parts of the media are available for
Expand All @@ -71,8 +72,9 @@
*
* <h2>Playlist of media files or on-demand streams</h2>
*
* <p style="align:center"><img src="doc-files/timeline-playlist.svg" alt="Example timeline for a
* playlist of files">
* <p style="align:center"><img
* src="https://exoplayer.dev/doc/reference/com/google/android/exoplayer2/doc-files/timeline-playlist.svg"
* alt="Example timeline for a playlist of files">
*
* <p>A timeline for a playlist of media files or on-demand streams consists of multiple periods,
* each with its own window. Each window spans the whole of the corresponding period, and typically
Expand All @@ -82,8 +84,9 @@
*
* <h2 id="live-limited">Live stream with limited availability</h2>
*
* <p style="align:center"><img src="doc-files/timeline-live-limited.svg" alt="Example timeline for
* a live stream with limited availability">
* <p style="align:center"><img
* src="https://exoplayer.dev/doc/reference/com/google/android/exoplayer2/doc-files/timeline-live-limited.svg"
* alt="Example timeline for a live stream with limited availability">
*
* <p>A timeline for a live stream consists of a period whose duration is unknown, since it's
* continually extending as more content is broadcast. If content only remains available for a
Expand All @@ -95,8 +98,9 @@
*
* <h2>Live stream with indefinite availability</h2>
*
* <p style="align:center"><img src="doc-files/timeline-live-indefinite.svg" alt="Example timeline
* for a live stream with indefinite availability">
* <p style="align:center"><img
* src="https://exoplayer.dev/doc/reference/com/google/android/exoplayer2/doc-files/timeline-live-indefinite.svg"
* alt="Example timeline for a live stream with indefinite availability">
*
* <p>A timeline for a live stream with indefinite availability is similar to the <a
* href="#live-limited">Live stream with limited availability</a> case, except that the window
Expand All @@ -105,8 +109,9 @@
*
* <h2 id="live-multi-period">Live stream with multiple periods</h2>
*
* <p style="align:center"><img src="doc-files/timeline-live-multi-period.svg" alt="Example timeline
* for a live stream with multiple periods">
* <p style="align:center"><img
* src="https://exoplayer.dev/doc/reference/com/google/android/exoplayer2/doc-files/timeline-live-multi-period.svg"
* alt="Example timeline for a live stream with multiple periods">
*
* <p>This case arises when a live stream is explicitly divided into separate periods, for example
* at content boundaries. This case is similar to the <a href="#live-limited">Live stream with
Expand All @@ -115,8 +120,9 @@
*
* <h2>On-demand stream followed by live stream</h2>
*
* <p style="align:center"><img src="doc-files/timeline-advanced.svg" alt="Example timeline for an
* on-demand stream followed by a live stream">
* <p style="align:center"><img
* src="https://exoplayer.dev/doc/reference/com/google/android/exoplayer2/doc-files/timeline-advanced.svg"
* alt="Example timeline for an on-demand stream followed by a live stream">
*
* <p>This case is the concatenation of the <a href="#single-file">Single media file or on-demand
* stream</a> and <a href="#multi-period">Live stream with multiple periods</a> cases. When playback
Expand All @@ -125,12 +131,15 @@
*
* <h2 id="single-file-midrolls">On-demand stream with mid-roll ads</h2>
*
* <p style="align:center"><img src="doc-files/timeline-single-file-midrolls.svg" alt="Example
* timeline for an on-demand stream with mid-roll ad groups">
* <p style="align:center"><img
* src="https://exoplayer.dev/doc/reference/com/google/android/exoplayer2/doc-files/timeline-single-file-midrolls.svg"
* alt="Example timeline for an on-demand stream with mid-roll ad groups">
*
* <p>This case includes mid-roll ad groups, which are defined as part of the timeline's single
* period. The period can be queried for information about the ad groups and the ads they contain.
*/
// TODO(b/276289331): Revert to media3-hosted SVG links above once they're available on
// developer.android.com.
public abstract class Timeline implements Bundleable {

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -129,8 +129,9 @@
*
* <p>The figure below shows ExoPlayer's threading model.
*
* <p style="align:center"><img src="doc-files/exoplayer-threading-model.svg" alt="ExoPlayer's
* threading model">
* <p style="align:center"><img
* src="https://exoplayer.dev/doc/reference/com/google/android/exoplayer2/doc-files/exoplayer-threading-model.svg"
* alt="ExoPlayer's threading model">
*
* <ul>
* <li>ExoPlayer instances must be accessed from a single application thread unless indicated
Expand Down Expand Up @@ -159,6 +160,8 @@
* may use background threads to load data. These are implementation specific.
* </ul>
*/
// TODO(b/276289331): Revert to media3-hosted SVG links above once they're available on
// developer.android.com.
public interface ExoPlayer extends Player {

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,12 @@
* valid state transitions are shown below, annotated with the methods that are called during each
* transition.
*
* <p style="align:center"><img src="doc-files/renderer-states.svg" alt="Renderer state
* transitions">
* <p style="align:center"><img
* src="https://exoplayer.dev/doc/reference/com/google/android/exoplayer2/doc-files/renderer-states.svg"
* alt="Renderer state transitions">
*/
// TODO(b/276289331): Revert to media3-hosted SVG links above once they're available on
// developer.android.com.
@UnstableApi
public interface Renderer extends PlayerMessage.Target {

Expand Down

0 comments on commit 2e4f49f

Please sign in to comment.