Fix STATE_IDLE Javadoc

Since playlist support was added, it's possible for the player to "have media"
and be in STATE_IDLE. The STATE_IDLE documentation therefore became incorrect.

Issue: #8946
#exofixit
#minor-release
PiperOrigin-RevId: 395653716
This commit is contained in:
olly 2021-09-09 10:13:23 +01:00 committed by Christos Tsilopoulos
parent 9046124f97
commit 051e18b26f

View File

@ -988,11 +988,12 @@ public interface Player {
@Retention(RetentionPolicy.SOURCE)
@IntDef({STATE_IDLE, STATE_BUFFERING, STATE_READY, STATE_ENDED})
@interface State {}
/** The player does not have any media to play. */
/** The player is idle, and must be {@link #prepare() prepared} before it will play the media. */
int STATE_IDLE = 1;
/**
* The player is not able to immediately play from its current position. This state typically
* occurs when more data needs to be loaded.
* The player is not able to immediately play the media, but is doing work toward being able to do
* so. This state typically occurs when the player needs to buffer more data before playback can
* start.
*/
int STATE_BUFFERING = 2;
/**