loliball/media3
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Javadoc cleanup: ExoPlayer#x -> #x

Browse Source 
-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=130369177
This commit is contained in:
olly 2016-08-16 00:34:08 -07:00 committed by Oliver Woodman
parent 096f85202e
commit 18a8655343
1 changed files with 19 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -108,8 +108,8 @@ public interface ExoPlayer {
void onLoadingChanged(boolean isLoading); void onLoadingChanged(boolean isLoading);
/** /**
* Called when the value returned from either {@link ExoPlayer#getPlayWhenReady()} or * Called when the value returned from either {@link #getPlayWhenReady()} or
* {@link ExoPlayer#getPlaybackState()} changes. * {@link #getPlaybackState()} changes.
* *
* @param playWhenReady Whether playback will proceed when ready. * @param playWhenReady Whether playback will proceed when ready.
* @param playbackState One of the {@code STATE} constants defined in the {@link ExoPlayer} * @param playbackState One of the {@code STATE} constants defined in the {@link ExoPlayer}
@ -118,13 +118,13 @@ public interface ExoPlayer {
void onPlayerStateChanged(boolean playWhenReady, int playbackState); void onPlayerStateChanged(boolean playWhenReady, int playbackState);
/** /**
* Called when the current value of {@link ExoPlayer#getPlayWhenReady()} has been reflected by * Called when the current value of {@link #getPlayWhenReady()} has been reflected by
* the internal playback thread. * the internal playback thread.
* <p> * <p>
* An invocation of this method will shortly follow any call to * An invocation of this method will shortly follow any call to
* {@link ExoPlayer#setPlayWhenReady(boolean)} that changes the state. If multiple calls are * {@link #setPlayWhenReady(boolean)} that changes the state. If multiple calls are made in
* made in rapid succession, then this method will be called only once, after the final state * rapid succession, then this method will be called only once, after the final state has been
* has been reflected. * reflected.
*/ */
void onPlayWhenReadyCommitted(); void onPlayWhenReadyCommitted();
@ -147,10 +147,9 @@ public interface ExoPlayer {
void onSourceInfoRefreshed(Timeline timeline, Object manifest); void onSourceInfoRefreshed(Timeline timeline, Object manifest);
/** /**
* Called when an error occurs. The playback state will transition to * Called when an error occurs. The playback state will transition to {@link #STATE_IDLE}
* {@link ExoPlayer#STATE_IDLE} immediately after this method is called. The player instance can * immediately after this method is called. The player instance can still be used, and
* still be used, and {@link ExoPlayer#release()} must still be called on the player should it * {@link #release()} must still be called on the player should it no longer be required.
* no longer be required.
* *
* @param error The error. * @param error The error.
*/ */
@ -161,8 +160,8 @@ public interface ExoPlayer {
/** /**
* A component of an {@link ExoPlayer} that can receive messages on the playback thread. * A component of an {@link ExoPlayer} that can receive messages on the playback thread.
* <p> * <p>
* Messages can be delivered to a component via {@link ExoPlayer#sendMessages} and * Messages can be delivered to a component via {@link #sendMessages} and
* {@link ExoPlayer#blockingSendMessages}. * {@link #blockingSendMessages}.
*/ */
interface ExoPlayerComponent { interface ExoPlayerComponent {
@ -279,8 +278,8 @@ public interface ExoPlayer {
boolean getPlayWhenReady(); boolean getPlayWhenReady();
/** /**
* Whether the current value of {@link ExoPlayer#getPlayWhenReady()} has been reflected by the * Whether the current value of {@link #getPlayWhenReady()} has been reflected by the internal
* internal playback thread. * playback thread.
* *
* @return Whether the current value has been reflected. * @return Whether the current value has been reflected.
*/ */
@ -323,9 +322,9 @@ public interface ExoPlayer {
* Stops playback. Use {@code setPlayWhenReady(false)} rather than this method if the intention * Stops playback. Use {@code setPlayWhenReady(false)} rather than this method if the intention
* is to pause playback. * is to pause playback.
* <p> * <p>
* Calling this method will cause the playback state to transition to * Calling this method will cause the playback state to transition to {@link #STATE_IDLE}. The
* {@link ExoPlayer#STATE_IDLE}. The player instance can still be used, and * player instance can still be used, and {@link #release()} must still be called on the player if
* {@link ExoPlayer#release()} must still be called on the player if it's no longer required. * it's no longer required.
* <p> * <p>
* Calling this method does not reset the playback position. * Calling this method does not reset the playback position.
*/ */
@ -355,8 +354,8 @@ public interface ExoPlayer {
void blockingSendMessages(ExoPlayerMessage... messages); void blockingSendMessages(ExoPlayerMessage... messages);
/** /**
* Returns the duration of the current period in milliseconds, or {@link ExoPlayer#UNKNOWN_TIME} * Returns the duration of the current period in milliseconds, or {@link #UNKNOWN_TIME} if the
* if the duration is not known. * duration is not known.
*/ */
long getDuration(); long getDuration();
@ -383,7 +382,7 @@ public interface ExoPlayer {
/** /**
* Returns an estimate of the absolute position in milliseconds up to which data is buffered, * Returns an estimate of the absolute position in milliseconds up to which data is buffered,
* or {@link ExoPlayer#UNKNOWN_TIME} if no estimate is available. * or {@link #UNKNOWN_TIME} if no estimate is available.
*/ */
long getBufferedPosition(); long getBufferedPosition();