sjs/media
1
0
Fork 0
mirror of https://github.com/samsonjs/media.git synced 2026-04-05 11:15:46 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

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
(cherry picked from commit 95e742948c)
This commit is contained in:
ibaker 2024-01-04 07:39:05 -08:00 committed by microkatz
parent 141f9b760d
commit d55b33474e
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

@ -2152,6 +2152,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}.
*
@ -2162,6 +2165,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}.
*
@ -2175,6 +2181,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}.
*
@ -2194,6 +2203,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}.
*
@ -2204,6 +2216,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}.
*
@ -2216,6 +2231,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}.
*
@ -2302,6 +2320,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}.
*
@ -2314,6 +2336,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}.
*