Skip to content

SDK / exoplayer

Go to a project
Commit e2ece2f5 by tonihei Committed by christosts
Options

Add missing command checks in UI module 

The commands are partly checked already before enabling
features or calling player methods, but the checks were
still missing in many places.

#minor-release

PiperOrigin-RevId: 504589888
parent e8ffc7b6
Expand all
Inline Side-by-side
Showing with 114 additions and 25 deletions
libraries/ui/src/main/java/androidx/media3/ui/DefaultMediaDescriptionAdapter.java
...@@ -15,6 +15,8 @@ ...@@ -15,6 +15,8 @@
*/ */
package androidx.media3.ui; package androidx.media3.ui;
import static androidx.media3.common.Player.COMMAND_GET_MEDIA_ITEMS_METADATA;
import android.app.PendingIntent; import android.app.PendingIntent;
import android.graphics.Bitmap; import android.graphics.Bitmap;
import android.graphics.BitmapFactory; import android.graphics.BitmapFactory;
...@@ -48,6 +50,9 @@ public final class DefaultMediaDescriptionAdapter implements MediaDescriptionAda ...@@ -48,6 +50,9 @@ public final class DefaultMediaDescriptionAdapter implements MediaDescriptionAda
@Override @Override
public CharSequence getCurrentContentTitle(Player player) { public CharSequence getCurrentContentTitle(Player player) {
if (!player.isCommandAvailable(COMMAND_GET_MEDIA_ITEMS_METADATA)) {
return "";
}
@Nullable CharSequence displayTitle = player.getMediaMetadata().displayTitle; @Nullable CharSequence displayTitle = player.getMediaMetadata().displayTitle;
if (!TextUtils.isEmpty(displayTitle)) { if (!TextUtils.isEmpty(displayTitle)) {
return displayTitle; return displayTitle;
...@@ -66,6 +71,9 @@ public final class DefaultMediaDescriptionAdapter implements MediaDescriptionAda ...@@ -66,6 +71,9 @@ public final class DefaultMediaDescriptionAdapter implements MediaDescriptionAda
@Nullable @Nullable
@Override @Override
public CharSequence getCurrentContentText(Player player) { public CharSequence getCurrentContentText(Player player) {
if (!player.isCommandAvailable(COMMAND_GET_MEDIA_ITEMS_METADATA)) {
return null;
}
@Nullable CharSequence artist = player.getMediaMetadata().artist; @Nullable CharSequence artist = player.getMediaMetadata().artist;
if (!TextUtils.isEmpty(artist)) { if (!TextUtils.isEmpty(artist)) {
return artist; return artist;
...@@ -77,6 +85,9 @@ public final class DefaultMediaDescriptionAdapter implements MediaDescriptionAda ...@@ -77,6 +85,9 @@ public final class DefaultMediaDescriptionAdapter implements MediaDescriptionAda
@Nullable @Nullable
@Override @Override
public Bitmap getCurrentLargeIcon(Player player, BitmapCallback callback) { public Bitmap getCurrentLargeIcon(Player player, BitmapCallback callback) {
if (!player.isCommandAvailable(COMMAND_GET_MEDIA_ITEMS_METADATA)) {
return null;
}
@Nullable byte[] data = player.getMediaMetadata().artworkData; @Nullable byte[] data = player.getMediaMetadata().artworkData;
if (data == null) { if (data == null) {
return null; return null;
......
libraries/ui/src/main/java/androidx/media3/ui/PlayerNotificationManager.java
...@@ -15,10 +15,17 @@ ...@@ -15,10 +15,17 @@
*/ */
package androidx.media3.ui; package androidx.media3.ui;
import static androidx.media3.common.Player.COMMAND_CHANGE_MEDIA_ITEMS;
import static androidx.media3.common.Player.COMMAND_GET_CURRENT_MEDIA_ITEM;
import static androidx.media3.common.Player.COMMAND_GET_TIMELINE;
import static androidx.media3.common.Player.COMMAND_PLAY_PAUSE;
import static androidx.media3.common.Player.COMMAND_PREPARE;
import static androidx.media3.common.Player.COMMAND_SEEK_BACK; import static androidx.media3.common.Player.COMMAND_SEEK_BACK;
import static androidx.media3.common.Player.COMMAND_SEEK_FORWARD; import static androidx.media3.common.Player.COMMAND_SEEK_FORWARD;
import static androidx.media3.common.Player.COMMAND_SEEK_TO_DEFAULT_POSITION;
import static androidx.media3.common.Player.COMMAND_SEEK_TO_NEXT; import static androidx.media3.common.Player.COMMAND_SEEK_TO_NEXT;
import static androidx.media3.common.Player.COMMAND_SEEK_TO_PREVIOUS; import static androidx.media3.common.Player.COMMAND_SEEK_TO_PREVIOUS;
import static androidx.media3.common.Player.COMMAND_STOP;
import static androidx.media3.common.Player.EVENT_IS_PLAYING_CHANGED; import static androidx.media3.common.Player.EVENT_IS_PLAYING_CHANGED;
import static androidx.media3.common.Player.EVENT_MEDIA_METADATA_CHANGED; import static androidx.media3.common.Player.EVENT_MEDIA_METADATA_CHANGED;
import static androidx.media3.common.Player.EVENT_PLAYBACK_PARAMETERS_CHANGED; import static androidx.media3.common.Player.EVENT_PLAYBACK_PARAMETERS_CHANGED;
...@@ -1205,7 +1212,9 @@ public class PlayerNotificationManager { ...@@ -1205,7 +1212,9 @@ public class PlayerNotificationManager {
@Nullable NotificationCompat.Builder builder, @Nullable NotificationCompat.Builder builder,
boolean ongoing, boolean ongoing,
@Nullable Bitmap largeIcon) { @Nullable Bitmap largeIcon) {
if (player.getPlaybackState() == Player.STATE_IDLE && player.getCurrentTimeline().isEmpty()) { if (player.getPlaybackState() == Player.STATE_IDLE
&& player.isCommandAvailable(COMMAND_GET_TIMELINE)
&& player.getCurrentTimeline().isEmpty()) {
builderActions = null; builderActions = null;
return null; return null;
} }
...@@ -1259,6 +1268,7 @@ public class PlayerNotificationManager { ...@@ -1259,6 +1268,7 @@ public class PlayerNotificationManager {
// Changing "showWhen" causes notification flicker if SDK_INT < 21. // Changing "showWhen" causes notification flicker if SDK_INT < 21.
if (Util.SDK_INT >= 21 if (Util.SDK_INT >= 21
&& useChronometer && useChronometer
&& player.isCommandAvailable(COMMAND_GET_CURRENT_MEDIA_ITEM)
&& player.isPlaying() && player.isPlaying()
&& !player.isPlayingAd() && !player.isPlayingAd()
&& !player.isCurrentMediaItemDynamic() && !player.isCurrentMediaItemDynamic()
...@@ -1537,24 +1547,43 @@ public class PlayerNotificationManager { ...@@ -1537,24 +1547,43 @@ public class PlayerNotificationManager {
} }
String action = intent.getAction(); String action = intent.getAction();
if (ACTION_PLAY.equals(action)) { if (ACTION_PLAY.equals(action)) {
if (player.getPlaybackState() == Player.STATE_IDLE) { if (player.getPlaybackState() == Player.STATE_IDLE
&& player.isCommandAvailable(COMMAND_PREPARE)) {
player.prepare(); player.prepare();
} else if (player.getPlaybackState() == Player.STATE_ENDED) { } else if (player.getPlaybackState() == Player.STATE_ENDED
player.seekToDefaultPosition(player.getCurrentMediaItemIndex()); && player.isCommandAvailable(COMMAND_SEEK_TO_DEFAULT_POSITION)) {
player.seekToDefaultPosition();
}
if (player.isCommandAvailable(COMMAND_PLAY_PAUSE)) {
player.play();
} }
player.play();
} else if (ACTION_PAUSE.equals(action)) { } else if (ACTION_PAUSE.equals(action)) {
player.pause(); if (player.isCommandAvailable(COMMAND_PLAY_PAUSE)) {
player.pause();
}
} else if (ACTION_PREVIOUS.equals(action)) { } else if (ACTION_PREVIOUS.equals(action)) {
player.seekToPrevious(); if (player.isCommandAvailable(COMMAND_SEEK_TO_PREVIOUS)) {
player.seekToPrevious();
}
} else if (ACTION_REWIND.equals(action)) { } else if (ACTION_REWIND.equals(action)) {
player.seekBack(); if (player.isCommandAvailable(COMMAND_SEEK_BACK)) {
player.seekBack();
}
} else if (ACTION_FAST_FORWARD.equals(action)) { } else if (ACTION_FAST_FORWARD.equals(action)) {
player.seekForward(); if (player.isCommandAvailable(COMMAND_SEEK_FORWARD)) {
player.seekForward();
}
} else if (ACTION_NEXT.equals(action)) { } else if (ACTION_NEXT.equals(action)) {
player.seekToNext(); if (player.isCommandAvailable(COMMAND_SEEK_TO_NEXT)) {
player.seekToNext();
}
} else if (ACTION_STOP.equals(action)) { } else if (ACTION_STOP.equals(action)) {
player.stop(/* reset= */ true); if (player.isCommandAvailable(COMMAND_STOP)) {
player.stop();
}
if (player.isCommandAvailable(COMMAND_CHANGE_MEDIA_ITEMS)) {
player.clearMediaItems();
}
} else if (ACTION_DISMISS.equals(action)) { } else if (ACTION_DISMISS.equals(action)) {
stopNotification(/* dismissedByUser= */ true); stopNotification(/* dismissedByUser= */ true);
} else if (action != null } else if (action != null
......
libraries/ui/src/main/java/androidx/media3/ui/PlayerView.java
...@@ -15,7 +15,11 @@ ...@@ -15,7 +15,11 @@
*/ */
package androidx.media3.ui; package androidx.media3.ui;
import static androidx.media3.common.Player.COMMAND_GET_CURRENT_MEDIA_ITEM;
import static androidx.media3.common.Player.COMMAND_GET_MEDIA_ITEMS_METADATA;
import static androidx.media3.common.Player.COMMAND_GET_TEXT; import static androidx.media3.common.Player.COMMAND_GET_TEXT;
import static androidx.media3.common.Player.COMMAND_GET_TIMELINE;
import static androidx.media3.common.Player.COMMAND_GET_TRACKS;
import static androidx.media3.common.Player.COMMAND_SET_VIDEO_SURFACE; import static androidx.media3.common.Player.COMMAND_SET_VIDEO_SURFACE;
import static androidx.media3.common.util.Assertions.checkNotNull; import static androidx.media3.common.util.Assertions.checkNotNull;
import static androidx.media3.common.util.Util.getDrawable; import static androidx.media3.common.util.Util.getDrawable;
...@@ -527,10 +531,12 @@ public class PlayerView extends FrameLayout implements AdViewProvider { ...@@ -527,10 +531,12 @@ public class PlayerView extends FrameLayout implements AdViewProvider {
@Nullable Player oldPlayer = this.player; @Nullable Player oldPlayer = this.player;
if (oldPlayer != null) { if (oldPlayer != null) {
oldPlayer.removeListener(componentListener); oldPlayer.removeListener(componentListener);
if (surfaceView instanceof TextureView) { if (oldPlayer.isCommandAvailable(COMMAND_SET_VIDEO_SURFACE)) {
oldPlayer.clearVideoTextureView((TextureView) surfaceView); if (surfaceView instanceof TextureView) {
} else if (surfaceView instanceof SurfaceView) { oldPlayer.clearVideoTextureView((TextureView) surfaceView);
oldPlayer.clearVideoSurfaceView((SurfaceView) surfaceView); } else if (surfaceView instanceof SurfaceView) {
oldPlayer.clearVideoSurfaceView((SurfaceView) surfaceView);
}
} }
} }
if (subtitleView != null) { if (subtitleView != null) {
...@@ -743,7 +749,9 @@ public class PlayerView extends FrameLayout implements AdViewProvider { ...@@ -743,7 +749,9 @@ public class PlayerView extends FrameLayout implements AdViewProvider {
@Override @Override
public boolean dispatchKeyEvent(KeyEvent event) { public boolean dispatchKeyEvent(KeyEvent event) {
if (player != null && player.isPlayingAd()) { if (player != null
&& player.isCommandAvailable(COMMAND_GET_CURRENT_MEDIA_ITEM)
&& player.isPlayingAd()) {
return super.dispatchKeyEvent(event); return super.dispatchKeyEvent(event);
} }
...@@ -1274,7 +1282,8 @@ public class PlayerView extends FrameLayout implements AdViewProvider { ...@@ -1274,7 +1282,8 @@ public class PlayerView extends FrameLayout implements AdViewProvider {
} }
int playbackState = player.getPlaybackState(); int playbackState = player.getPlaybackState();
return controllerAutoShow return controllerAutoShow
&& !player.getCurrentTimeline().isEmpty() && (!player.isCommandAvailable(COMMAND_GET_TIMELINE)
|| !player.getCurrentTimeline().isEmpty())
&& (playbackState == Player.STATE_IDLE && (playbackState == Player.STATE_IDLE
|| playbackState == Player.STATE_ENDED || playbackState == Player.STATE_ENDED
|| !checkNotNull(player).getPlayWhenReady()); || !checkNotNull(player).getPlayWhenReady());
...@@ -1289,12 +1298,17 @@ public class PlayerView extends FrameLayout implements AdViewProvider { ...@@ -1289,12 +1298,17 @@ public class PlayerView extends FrameLayout implements AdViewProvider {
} }
private boolean isPlayingAd() { private boolean isPlayingAd() {
return player != null && player.isPlayingAd() && player.getPlayWhenReady(); return player != null
&& player.isCommandAvailable(COMMAND_GET_CURRENT_MEDIA_ITEM)
&& player.isPlayingAd()
&& player.getPlayWhenReady();
} }
private void updateForCurrentTrackSelections(boolean isNewPlayer) { private void updateForCurrentTrackSelections(boolean isNewPlayer) {
@Nullable Player player = this.player; @Nullable Player player = this.player;
if (player == null || player.getCurrentTracks().isEmpty()) { if (player == null
|| !player.isCommandAvailable(COMMAND_GET_TRACKS)
|| player.getCurrentTracks().isEmpty()) {
if (!keepContentOnPlayerReset) { if (!keepContentOnPlayerReset) {
hideArtwork(); hideArtwork();
closeShutter(); closeShutter();
...@@ -1318,7 +1332,7 @@ public class PlayerView extends FrameLayout implements AdViewProvider { ...@@ -1318,7 +1332,7 @@ public class PlayerView extends FrameLayout implements AdViewProvider {
closeShutter(); closeShutter();
// Display artwork if enabled and available, else hide it. // Display artwork if enabled and available, else hide it.
if (useArtwork()) { if (useArtwork()) {
if (setArtworkFromMediaMetadata(player.getMediaMetadata())) { if (setArtworkFromMediaMetadata(player)) {
return; return;
} }
if (setDrawableArtwork(defaultArtwork)) { if (setDrawableArtwork(defaultArtwork)) {
...@@ -1330,7 +1344,11 @@ public class PlayerView extends FrameLayout implements AdViewProvider { ...@@ -1330,7 +1344,11 @@ public class PlayerView extends FrameLayout implements AdViewProvider {
} }
@RequiresNonNull("artworkView") @RequiresNonNull("artworkView")
private boolean setArtworkFromMediaMetadata(MediaMetadata mediaMetadata) { private boolean setArtworkFromMediaMetadata(Player player) {
if (!player.isCommandAvailable(COMMAND_GET_MEDIA_ITEMS_METADATA)) {
return false;
}
MediaMetadata mediaMetadata = player.getMediaMetadata();
if (mediaMetadata.artworkData == null) { if (mediaMetadata.artworkData == null) {
return false; return false;
} }
...@@ -1549,10 +1567,14 @@ public class PlayerView extends FrameLayout implements AdViewProvider { ...@@ -1549,10 +1567,14 @@ public class PlayerView extends FrameLayout implements AdViewProvider {
// is necessary to avoid closing the shutter when such a transition occurs. See: // is necessary to avoid closing the shutter when such a transition occurs. See:
// https://github.com/google/ExoPlayer/issues/5507. // https://github.com/google/ExoPlayer/issues/5507.
Player player = checkNotNull(PlayerView.this.player); Player player = checkNotNull(PlayerView.this.player);
Timeline timeline = player.getCurrentTimeline(); Timeline timeline =
player.isCommandAvailable(COMMAND_GET_TIMELINE)
? player.getCurrentTimeline()
: Timeline.EMPTY;
if (timeline.isEmpty()) { if (timeline.isEmpty()) {
lastPeriodUidWithTracks = null; lastPeriodUidWithTracks = null;
} else if (!player.getCurrentTracks().isEmpty()) { } else if (player.isCommandAvailable(COMMAND_GET_TRACKS)
&& !player.getCurrentTracks().isEmpty()) {
lastPeriodUidWithTracks = lastPeriodUidWithTracks =
timeline.getPeriod(player.getCurrentPeriodIndex(), period, /* setIds= */ true).uid; timeline.getPeriod(player.getCurrentPeriodIndex(), period, /* setIds= */ true).uid;
} else if (lastPeriodUidWithTracks != null) { } else if (lastPeriodUidWithTracks != null) {
......
libraries/ui/src/main/java/androidx/media3/ui/TrackSelectionDialogBuilder.java
...@@ -15,6 +15,9 @@ ...@@ -15,6 +15,9 @@
*/ */
package androidx.media3.ui; package androidx.media3.ui;
import static androidx.media3.common.Player.COMMAND_GET_TRACKS;
import static androidx.media3.common.Player.COMMAND_SET_TRACK_SELECTION_PARAMETERS;
import android.app.AlertDialog; import android.app.AlertDialog;
import android.app.Dialog; import android.app.Dialog;
import android.content.Context; import android.content.Context;
...@@ -102,7 +105,9 @@ public final class TrackSelectionDialogBuilder { ...@@ -102,7 +105,9 @@ public final class TrackSelectionDialogBuilder {
Context context, CharSequence title, Player player, @C.TrackType int trackType) { Context context, CharSequence title, Player player, @C.TrackType int trackType) {
this.context = context; this.context = context;
this.title = title; this.title = title;
List<Tracks.Group> allTrackGroups = player.getCurrentTracks().getGroups(); Tracks tracks =
player.isCommandAvailable(COMMAND_GET_TRACKS) ? player.getCurrentTracks() : Tracks.EMPTY;
List<Tracks.Group> allTrackGroups = tracks.getGroups();
trackGroups = new ArrayList<>(); trackGroups = new ArrayList<>();
for (int i = 0; i < allTrackGroups.size(); i++) { for (int i = 0; i < allTrackGroups.size(); i++) {
Tracks.Group trackGroup = allTrackGroups.get(i); Tracks.Group trackGroup = allTrackGroups.get(i);
...@@ -113,6 +118,9 @@ public final class TrackSelectionDialogBuilder { ...@@ -113,6 +118,9 @@ public final class TrackSelectionDialogBuilder {
overrides = player.getTrackSelectionParameters().overrides; overrides = player.getTrackSelectionParameters().overrides;
callback = callback =
(isDisabled, overrides) -> { (isDisabled, overrides) -> {
if (!player.isCommandAvailable(COMMAND_SET_TRACK_SELECTION_PARAMETERS)) {
return;
}
TrackSelectionParameters.Builder parametersBuilder = TrackSelectionParameters.Builder parametersBuilder =
player.getTrackSelectionParameters().buildUpon(); player.getTrackSelectionParameters().buildUpon();
parametersBuilder.setTrackTypeDisabled(trackType, isDisabled); parametersBuilder.setTrackTypeDisabled(trackType, isDisabled);
......
libraries/ui/src/test/java/androidx/media3/ui/DefaultMediaDescriptionAdapterTest.java
...@@ -34,7 +34,7 @@ import org.junit.runner.RunWith; ...@@ -34,7 +34,7 @@ import org.junit.runner.RunWith;
public class DefaultMediaDescriptionAdapterTest { public class DefaultMediaDescriptionAdapterTest {
@Test @Test
public void getters_returnMediaMetadataValues() { public void getters_withGetMetatadataCommandAvailable_returnMediaMetadataValues() {
Context context = ApplicationProvider.getApplicationContext(); Context context = ApplicationProvider.getApplicationContext();
Player player = mock(Player.class); Player player = mock(Player.class);
MediaMetadata mediaMetadata = MediaMetadata mediaMetadata =
...@@ -43,6 +43,7 @@ public class DefaultMediaDescriptionAdapterTest { ...@@ -43,6 +43,7 @@ public class DefaultMediaDescriptionAdapterTest {
PendingIntent.getActivity(context, 0, new Intent(), PendingIntent.FLAG_IMMUTABLE); PendingIntent.getActivity(context, 0, new Intent(), PendingIntent.FLAG_IMMUTABLE);
DefaultMediaDescriptionAdapter adapter = new DefaultMediaDescriptionAdapter(pendingIntent); DefaultMediaDescriptionAdapter adapter = new DefaultMediaDescriptionAdapter(pendingIntent);
when(player.isCommandAvailable(Player.COMMAND_GET_MEDIA_ITEMS_METADATA)).thenReturn(true);
when(player.getMediaMetadata()).thenReturn(mediaMetadata); when(player.getMediaMetadata()).thenReturn(mediaMetadata);
assertThat(adapter.createCurrentContentIntent(player)).isEqualTo(pendingIntent); assertThat(adapter.createCurrentContentIntent(player)).isEqualTo(pendingIntent);
...@@ -51,4 +52,22 @@ public class DefaultMediaDescriptionAdapterTest { ...@@ -51,4 +52,22 @@ public class DefaultMediaDescriptionAdapterTest {
assertThat(adapter.getCurrentContentText(player).toString()) assertThat(adapter.getCurrentContentText(player).toString())
.isEqualTo(mediaMetadata.artist.toString()); .isEqualTo(mediaMetadata.artist.toString());
} }
@Test
public void getters_withoutGetMetatadataCommandAvailable_returnMediaMetadataValues() {
Context context = ApplicationProvider.getApplicationContext();
Player player = mock(Player.class);
MediaMetadata mediaMetadata =
new MediaMetadata.Builder().setDisplayTitle("display title").setArtist("artist").build();
PendingIntent pendingIntent =
PendingIntent.getActivity(context, 0, new Intent(), PendingIntent.FLAG_IMMUTABLE);
DefaultMediaDescriptionAdapter adapter = new DefaultMediaDescriptionAdapter(pendingIntent);
when(player.isCommandAvailable(Player.COMMAND_GET_MEDIA_ITEMS_METADATA)).thenReturn(false);
when(player.getMediaMetadata()).thenReturn(mediaMetadata);
assertThat(adapter.createCurrentContentIntent(player)).isEqualTo(pendingIntent);
assertThat(adapter.getCurrentContentTitle(player).toString()).isEqualTo("");
assertThat(adapter.getCurrentContentText(player)).isNull();
}
} }
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or sign in to comment