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

Fix bad @see Javadoc in CastPlayer

Browse Source 
-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=186305613
This commit is contained in:
olly 2018-02-20 08:21:19 -08:00 committed by Oliver Woodman
parent 356e979187
commit fba2b46a8b
1 changed files with 16 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
extensions/cast/src/main/java/com/google/android/exoplayer2/ext/cast/CastPlayer.java
View File

@ -195,14 +195,14 @@ public final class CastPlayer implements Player {
} }
/** /**
* Inserts a sequence of items into the media queue. If no media queue or period with id * Inserts a sequence of items into the media queue. If no media queue or period with id {@code
* {@code periodId} exist, does nothing. * periodId} exist, does nothing.
* *
* @param periodId The id of the period ({@see #getCurrentTimeline}) that corresponds to the item * @param periodId The id of the period ({@link #getCurrentTimeline}) that corresponds to the item
* that will follow immediately after the inserted items. * that will follow immediately after the inserted items.
* @param items The items to insert. * @param items The items to insert.
* @return The Cast {@code PendingResult}, or null if no media queue or no period with id * @return The Cast {@code PendingResult}, or null if no media queue or no period with id {@code
* {@code periodId} exist. * periodId} exist.
*/ */
public PendingResult<MediaChannelResult> addItems(int periodId, MediaQueueItem... items) { public PendingResult<MediaChannelResult> addItems(int periodId, MediaQueueItem... items) {
if (getMediaStatus() != null && (periodId == MediaQueueItem.INVALID_ITEM_ID if (getMediaStatus() != null && (periodId == MediaQueueItem.INVALID_ITEM_ID
@ -216,10 +216,10 @@ public final class CastPlayer implements Player {
* Removes an item from the media queue. If no media queue or period with id {@code periodId} * Removes an item from the media queue. If no media queue or period with id {@code periodId}
* exist, does nothing. * exist, does nothing.
* *
* @param periodId The id of the period ({@see #getCurrentTimeline}) that corresponds to the item * @param periodId The id of the period ({@link #getCurrentTimeline}) that corresponds to the item
* to remove. * to remove.
* @return The Cast {@code PendingResult}, or null if no media queue or no period with id * @return The Cast {@code PendingResult}, or null if no media queue or no period with id {@code
* {@code periodId} exist. * periodId} exist.
*/ */
public PendingResult<MediaChannelResult> removeItem(int periodId) { public PendingResult<MediaChannelResult> removeItem(int periodId) {
if (getMediaStatus() != null && currentTimeline.getIndexOfPeriod(periodId) != C.INDEX_UNSET) { if (getMediaStatus() != null && currentTimeline.getIndexOfPeriod(periodId) != C.INDEX_UNSET) {
@ -229,16 +229,15 @@ public final class CastPlayer implements Player {
} }
/** /**
* Moves an existing item within the media queue. If no media queue or period with id * Moves an existing item within the media queue. If no media queue or period with id {@code
* {@code periodId} exist, does nothing. * periodId} exist, does nothing.
* *
* @param periodId The id of the period ({@see #getCurrentTimeline}) that corresponds to the item * @param periodId The id of the period ({@link #getCurrentTimeline}) that corresponds to the item
* to move. * to move.
* @param newIndex The target index of the item in the media queue. Must be in the range * @param newIndex The target index of the item in the media queue. Must be in the range 0 &lt;=
* 0 &lt;= index &lt; {@link Timeline#getPeriodCount()}, as provided by * index &lt; {@link Timeline#getPeriodCount()}, as provided by {@link #getCurrentTimeline()}.
* {@link #getCurrentTimeline()}. * @return The Cast {@code PendingResult}, or null if no media queue or no period with id {@code
* @return The Cast {@code PendingResult}, or null if no media queue or no period with id * periodId} exist.
* {@code periodId} exist.
*/ */
public PendingResult<MediaChannelResult> moveItem(int periodId, int newIndex) { public PendingResult<MediaChannelResult> moveItem(int periodId, int newIndex) {
Assertions.checkArgument(newIndex >= 0 && newIndex < currentTimeline.getPeriodCount()); Assertions.checkArgument(newIndex >= 0 && newIndex < currentTimeline.getPeriodCount());
@ -252,7 +251,7 @@ public final class CastPlayer implements Player {
* Returns the item that corresponds to the period with the given id, or null if no media queue or * Returns the item that corresponds to the period with the given id, or null if no media queue or
* period with id {@code periodId} exist. * period with id {@code periodId} exist.
* *
* @param periodId The id of the period ({@see #getCurrentTimeline}) that corresponds to the item * @param periodId The id of the period ({@link #getCurrentTimeline}) that corresponds to the item
* to get. * to get.
* @return The item that corresponds to the period with the given id, or null if no media queue or * @return The item that corresponds to the period with the given id, or null if no media queue or
* period with id {@code periodId} exist. * period with id {@code periodId} exist.