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

Clarify docs on Player.setMediaItem(s) and replaceMediaItem(s)

Browse Source 
These methods sound similar, but have different behaviour. This change
tries to make the distinction clearer, and sign-post from one to the
other.

#minor-release

Issue: androidx/media#910
PiperOrigin-RevId: 595701540
This commit is contained in:
ibaker 2024-01-04 07:39:05 -08:00 committed by Copybara-Service
parent 5c50b27e8f
commit 95e742948c
1 changed files with 26 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
libraries/common/src/main/java/androidx/media3/common/Player.java
View File

@ -2173,6 +2173,9 @@ public interface Player {
* Clears the playlist, adds the specified {@linkplain MediaItem media items} and resets the
* position to the default position.
*
* <p>To replace a span of media items (possibly seamlessly) without clearing the playlist, use
* {@link #replaceMediaItems}.
*
* <p>This method must only be called if {@link #COMMAND_CHANGE_MEDIA_ITEMS} is {@linkplain
* #getAvailableCommands() available}.
*
@ -2183,6 +2186,9 @@ public interface Player {
/**
* Clears the playlist and adds the specified {@linkplain MediaItem media items}.
*
* <p>To replace a span of media items (possibly seamlessly) without clearing the playlist, use
* {@link #replaceMediaItems}.
*
* <p>This method must only be called if {@link #COMMAND_CHANGE_MEDIA_ITEMS} is {@linkplain
* #getAvailableCommands() available}.
*
@ -2196,6 +2202,9 @@ public interface Player {
/**
* Clears the playlist and adds the specified {@linkplain MediaItem media items}.
*
* <p>To replace a span of media items (possibly seamlessly) without clearing the playlist, use
* {@link #replaceMediaItems}.
*
* <p>This method must only be called if {@link #COMMAND_CHANGE_MEDIA_ITEMS} is {@linkplain
* #getAvailableCommands() available}.
*
@ -2215,6 +2224,9 @@ public interface Player {
* Clears the playlist, adds the specified {@link MediaItem} and resets the position to the
* default position.
*
* <p>To replace a media item (possibly seamlessly) without clearing the playlist, use {@link
* #replaceMediaItem}.
*
* <p>This method must only be called if {@link #COMMAND_SET_MEDIA_ITEM} is {@linkplain
* #getAvailableCommands() available}.
*
@ -2225,6 +2237,9 @@ public interface Player {
/**
* Clears the playlist and adds the specified {@link MediaItem}.
*
* <p>To replace a media item (possibly seamlessly) without clearing the playlist, use {@link
* #replaceMediaItem}.
*
* <p>This method must only be called if {@link #COMMAND_SET_MEDIA_ITEM} is {@linkplain
* #getAvailableCommands() available}.
*
@ -2237,6 +2252,9 @@ public interface Player {
/**
* Clears the playlist and adds the specified {@link MediaItem}.
*
* <p>To replace a media item (possibly seamlessly) without clearing the playlist, use {@link
* #replaceMediaItem}.
*
* <p>This method must only be called if {@link #COMMAND_SET_MEDIA_ITEM} is {@linkplain
* #getAvailableCommands() available}.
*
@ -2323,6 +2341,10 @@ public interface Player {
/**
* Replaces the media item at the given index of the playlist.
*
* <p>Implementations of this method may attempt to seamlessly continue playback if the currently
* playing media item is replaced with a compatible one (e.g. same URL, only metadata has
* changed).
*
* <p>This method must only be called if {@link #COMMAND_CHANGE_MEDIA_ITEMS} is {@linkplain
* #getAvailableCommands() available}.
*
@ -2335,6 +2357,10 @@ public interface Player {
/**
* Replaces the media items at the given range of the playlist.
*
* <p>Implementations of this method may attempt to seamlessly continue playback if the currently
* playing media item is replaced with a compatible one (e.g. same URL, only metadata has
* changed).
*
* <p>This method must only be called if {@link #COMMAND_CHANGE_MEDIA_ITEMS} is {@linkplain
* #getAvailableCommands() available}.
*