loliball/media
1
0
Fork 0
mirror of https://github.com/androidx/media.git synced 2025-04-30 06:46:50 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Fix javadoc warnings exposed by -Xdoclint

Browse Source 
PiperOrigin-RevId: 284776943
This commit is contained in:
ibaker 2019-12-10 16:42:33 +00:00 committed by Oliver Woodman
parent 614a92b607
commit c1573106fa
4 changed files with 29 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
library/core/src/main/java/com/google/android/exoplayer2/ExoPlayer.java
View File

@ -93,8 +93,8 @@ import com.google.android.exoplayer2.video.MediaCodecVideoRenderer;
* *
* <p>The figure below shows ExoPlayer's threading model. * <p>The figure below shows ExoPlayer's threading model.
* *
* <p align="center"><img src="doc-files/exoplayer-threading-model.svg" alt="ExoPlayer's threading * <p style="align:center"><img src="doc-files/exoplayer-threading-model.svg" alt="ExoPlayer's
* model"> * threading model">
* *
* <ul> * <ul>
* <li>ExoPlayer instances must be accessed from a single application thread. For the vast * <li>ExoPlayer instances must be accessed from a single application thread. For the vast

3
library/core/src/main/java/com/google/android/exoplayer2/Renderer.java
View File

@ -32,7 +32,8 @@ import java.lang.annotation.RetentionPolicy;
* valid state transitions are shown below, annotated with the methods that are called during each * valid state transitions are shown below, annotated with the methods that are called during each
* transition. * transition.
* *
* <p align="center"><img src="doc-files/renderer-states.svg" alt="Renderer state transitions"> * <p style="align:center"><img src="doc-files/renderer-states.svg" alt="Renderer state
* transitions">
*/ */
public interface Renderer extends PlayerMessage.Target { public interface Renderer extends PlayerMessage.Target {

50
library/core/src/main/java/com/google/android/exoplayer2/Timeline.java
View File

@ -45,7 +45,7 @@ import com.google.android.exoplayer2.util.Util;
* *
* <h3 id="single-file">Single media file or on-demand stream</h3> * <h3 id="single-file">Single media file or on-demand stream</h3>
* *
* <p align="center"><img src="doc-files/timeline-single-file.svg" alt="Example timeline for a * <p style="align:center"><img src="doc-files/timeline-single-file.svg" alt="Example timeline for a
* single file"> A timeline for a single media file or on-demand stream consists of a single period * single file"> 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 * and window. The window spans the whole period, indicating that all parts of the media are
* available for playback. The window's default position is typically at the start of the period * available for playback. The window's default position is typically at the start of the period
@ -53,17 +53,17 @@ import com.google.android.exoplayer2.util.Util;
* *
* <h3>Playlist of media files or on-demand streams</h3> * <h3>Playlist of media files or on-demand streams</h3>
* *
* <p align="center"><img src="doc-files/timeline-playlist.svg" alt="Example timeline for a playlist * <p style="align:center"><img src="doc-files/timeline-playlist.svg" alt="Example timeline for a
* of files"> A timeline for a playlist of media files or on-demand streams consists of multiple * playlist of files"> A timeline for a playlist of media files or on-demand streams consists of
* periods, each with its own window. Each window spans the whole of the corresponding period, and * multiple periods, each with its own window. Each window spans the whole of the corresponding
* typically has a default position at the start of the period. The properties of the periods and * period, and typically has a default position at the start of the period. The properties of the
* windows (e.g. their durations and whether the window is seekable) will often only become known * periods and windows (e.g. their durations and whether the window is seekable) will often only
* when the player starts buffering the corresponding file or stream. * become known when the player starts buffering the corresponding file or stream.
* *
* <h3 id="live-limited">Live stream with limited availability</h3> * <h3 id="live-limited">Live stream with limited availability</h3>
* *
* <p align="center"><img src="doc-files/timeline-live-limited.svg" alt="Example timeline for a live * <p style="align:center"><img src="doc-files/timeline-live-limited.svg" alt="Example timeline for
* stream with limited availability"> A timeline for a live stream consists of a period whose * a live stream with limited availability"> 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 * duration is unknown, since it's continually extending as more content is broadcast. If content
* only remains available for a limited period of time then the window may start at a non-zero * only remains available for a limited period of time then the window may start at a non-zero
* position, defining the region of content that can still be played. The window will have {@link * position, defining the region of content that can still be played. The window will have {@link
@ -73,24 +73,24 @@ import com.google.android.exoplayer2.util.Util;
* *
* <h3>Live stream with indefinite availability</h3> * <h3>Live stream with indefinite availability</h3>
* *
* <p align="center"><img src="doc-files/timeline-live-indefinite.svg" alt="Example timeline for a * <p style="align:center"><img src="doc-files/timeline-live-indefinite.svg" alt="Example timeline
* live stream with indefinite availability"> A timeline for a live stream with indefinite * for a live stream with indefinite availability"> A timeline for a live stream with indefinite
* availability is similar to the <a href="#live-limited">Live stream with limited availability</a> * availability is similar to the <a href="#live-limited">Live stream with limited availability</a>
* case, except that the window starts at the beginning of the period to indicate that all of the * case, except that the window starts at the beginning of the period to indicate that all of the
* previously broadcast content can still be played. * previously broadcast content can still be played.
* *
* <h3 id="live-multi-period">Live stream with multiple periods</h3> * <h3 id="live-multi-period">Live stream with multiple periods</h3>
* *
* <p align="center"><img src="doc-files/timeline-live-multi-period.svg" alt="Example timeline for a * <p style="align:center"><img src="doc-files/timeline-live-multi-period.svg" alt="Example timeline
* live stream with multiple periods"> This case arises when a live stream is explicitly divided * for a live stream with multiple periods"> This case arises when a live stream is explicitly
* into separate periods, for example at content boundaries. This case is similar to the <a * divided into separate periods, for example at content boundaries. This case is similar to the <a
* href="#live-limited">Live stream with limited availability</a> case, except that the window may * href="#live-limited">Live stream with limited availability</a> case, except that the window may
* span more than one period. Multiple periods are also possible in the indefinite availability * span more than one period. Multiple periods are also possible in the indefinite availability
* case. * case.
* *
* <h3>On-demand stream followed by live stream</h3> * <h3>On-demand stream followed by live stream</h3>
* *
* <p align="center"><img src="doc-files/timeline-advanced.svg" alt="Example timeline for an * <p style="align:center"><img src="doc-files/timeline-advanced.svg" alt="Example timeline for an
* on-demand stream followed by a live stream"> This case is the concatenation of the <a * on-demand stream followed by a live stream"> 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 * 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 of the on-demand stream ends, playback of * stream with multiple periods</a> cases. When playback of the on-demand stream ends, playback of
@ -98,10 +98,10 @@ import com.google.android.exoplayer2.util.Util;
* *
* <h3 id="single-file-midrolls">On-demand stream with mid-roll ads</h3> * <h3 id="single-file-midrolls">On-demand stream with mid-roll ads</h3>
* *
* <p align="center"><img src="doc-files/timeline-single-file-midrolls.svg" alt="Example timeline * <p style="align:center"><img src="doc-files/timeline-single-file-midrolls.svg" alt="Example
* for an on-demand stream with mid-roll ad groups"> This case includes mid-roll ad groups, which * timeline for an on-demand stream with mid-roll ad groups"> This case includes mid-roll ad groups,
* are defined as part of the timeline's single period. The period can be queried for information * which are defined as part of the timeline's single period. The period can be queried for
* about the ad groups and the ads they contain. * information about the ad groups and the ads they contain.
*/ */
public abstract class Timeline { public abstract class Timeline {
@ -112,7 +112,7 @@ public abstract class Timeline {
* shows some of the information defined by a window, as well as how this information relates to * shows some of the information defined by a window, as well as how this information relates to
* corresponding {@link Period Periods} in the timeline. * corresponding {@link Period Periods} in the timeline.
* *
* <p align="center"><img src="doc-files/timeline-window.svg" alt="Information defined by a * <p style="align:center"><img src="doc-files/timeline-window.svg" alt="Information defined by a
* timeline window"> * timeline window">
*/ */
public static final class Window { public static final class Window {
@ -327,12 +327,12 @@ public abstract class Timeline {
* Holds information about a period in a {@link Timeline}. A period defines a single logical piece * Holds information about a period in a {@link Timeline}. A period defines a single logical piece
* of media, for example a media file. It may also define groups of ads inserted into the media, * of media, for example a media file. It may also define groups of ads inserted into the media,
* along with information about whether those ads have been loaded and played. * along with information about whether those ads have been loaded and played.
* <p> *
* The figure below shows some of the information defined by a period, as well as how this * <p>The figure below shows some of the information defined by a period, as well as how this
* information relates to a corresponding {@link Window} in the timeline. * information relates to a corresponding {@link Window} in the timeline.
* <p align="center"> *
* <img src="doc-files/timeline-period.svg" alt="Information defined by a period"> * <p style="align:center"><img src="doc-files/timeline-period.svg" alt="Information defined by a
* </p> * period">
*/ */
public static final class Period { public static final class Period {

2
library/core/src/main/java/com/google/android/exoplayer2/trackselection/TrackSelector.java
View File

@ -36,8 +36,6 @@ import com.google.android.exoplayer2.util.Assertions;
* *
* The following interactions occur between the player and its track selector during playback. * The following interactions occur between the player and its track selector during playback.
* *
* <p>
*
* <ul> * <ul>
* <li>When the player is created it will initialize the track selector by calling {@link * <li>When the player is created it will initialize the track selector by calling {@link
* #init(InvalidationListener, BandwidthMeter)}. * #init(InvalidationListener, BandwidthMeter)}.