Merge pull request #2235 from MGaetan89:add_CastPlayer_playlistMetadata

PiperOrigin-RevId: 738455260

Author: copybara-github

Diff for: RELEASENOTES.md

@@ -54,6 +54,8 @@
 *   MIDI extension:
 *   Leanback extension:
 *   Cast extension:
+    *   Add support for playlist metadata
+        ([#2235](https://github.com/androidx/media/pull/2235)).
 *   Test Utilities:
 *   Demo app:
     *   Add `PlaybackSpeedPopUpButton` Composable UI element to be part of

Diff for: libraries/cast/src/main/java/androidx/media3/cast/CastPlayer.java

@@ -16,6 +16,7 @@
 package androidx.media3.cast;
 
 import static androidx.media3.common.util.Assertions.checkArgument;
+import static androidx.media3.common.util.Assertions.checkNotNull;
 import static androidx.media3.common.util.Util.SDK_INT;
 import static androidx.media3.common.util.Util.castNonNull;
 import static java.lang.Math.min;
@@ -166,6 +167,7 @@ public final class CastPlayer extends BasePlayer {
   private long pendingSeekPositionMs;
   @Nullable private PositionInfo pendingMediaItemRemovalPosition;
   private MediaMetadata mediaMetadata;
+  private MediaMetadata playlistMetadata;
   private DeviceInfo deviceInfo;
 
   /**
@@ -268,6 +270,7 @@ public CastPlayer(
     playbackState = STATE_IDLE;
     currentTimeline = CastTimeline.EMPTY_CAST_TIMELINE;
     mediaMetadata = MediaMetadata.EMPTY;
+    playlistMetadata = MediaMetadata.EMPTY;
     currentTracks = Tracks.EMPTY;
     availableCommands = new Commands.Builder().addAll(PERMANENT_AVAILABLE_COMMANDS).build();
     pendingSeekWindowIndex = C.INDEX_UNSET;
@@ -656,14 +659,19 @@ public MediaMetadata getMediaMetadataInternal() {
 
   @Override
   public MediaMetadata getPlaylistMetadata() {
-    // CastPlayer does not currently support metadata.
-    return MediaMetadata.EMPTY;
+    return playlistMetadata;
   }
 
-  /** This method is not supported and does nothing. */
   @Override
-  public void setPlaylistMetadata(MediaMetadata mediaMetadata) {
-    // CastPlayer does not currently support metadata.
+  public void setPlaylistMetadata(MediaMetadata playlistMetadata) {
+    checkNotNull(playlistMetadata);
+    if (playlistMetadata.equals(this.playlistMetadata)) {
+      return;
+    }
+    this.playlistMetadata = playlistMetadata;
+    listeners.sendEvent(
+        EVENT_PLAYLIST_METADATA_CHANGED,
+        listener -> listener.onPlaylistMetadataChanged(this.playlistMetadata));
   }
 
   @Override

Diff for: libraries/cast/src/test/java/androidx/media3/cast/CastPlayerTest.java

@@ -1800,7 +1800,7 @@ public void setRepeatMode_one_doesNotNotifyAvailableCommandsChanged() {
   }
 
   @Test
-  public void setMediaItems_doesNotifyOnMetadataChanged() {
+  public void setMediaItems_doesNotifyOnMediaMetadataChanged() {
     when(mockRemoteMediaClient.queueJumpToItem(anyInt(), anyLong(), eq(null)))
         .thenReturn(mockPendingResult);
     ArgumentCaptor<MediaMetadata> metadataCaptor = ArgumentCaptor.forClass(MediaMetadata.class);
@@ -1827,7 +1827,7 @@ public void setMediaItems_doesNotifyOnMetadataChanged() {
                 .build());
     castPlayer.addListener(mockListener);
 
-    MediaMetadata intitalMetadata = castPlayer.getMediaMetadata();
+    MediaMetadata initialMetadata = castPlayer.getMediaMetadata();
     castPlayer.setMediaItems(firstPlaylist, /* startIndex= */ 0, /* startPositionMs= */ 2000L);
     updateTimeLine(firstPlaylist, /* mediaQueueItemIds= */ new int[] {1}, /* currentItemId= */ 1);
     MediaMetadata firstMetadata = castPlayer.getMediaMetadata();
@@ -1850,7 +1850,7 @@ public void setMediaItems_doesNotifyOnMetadataChanged() {
             secondPlaylist.get(1).mediaMetadata,
             secondPlaylist.get(0).mediaMetadata)
         .inOrder();
-    assertThat(intitalMetadata).isEqualTo(MediaMetadata.EMPTY);
+    assertThat(initialMetadata).isEqualTo(MediaMetadata.EMPTY);
     assertThat(ImmutableList.of(firstMetadata, secondMetadata, thirdMetadata))
         .containsExactly(
             firstPlaylist.get(0).mediaMetadata,
@@ -1898,6 +1898,35 @@ public void setMediaItems_equalMetadata_doesNotNotifyOnMediaMetadataChanged() {
     verify(mockListener, never()).onMediaMetadataChanged(any());
   }
 
+  @Test
+  public void setPlaylistMetadata_doesNotifyOnPlaylistMetadataChanged() {
+    castPlayer.addListener(mockListener);
+
+    MediaMetadata metadata = new MediaMetadata.Builder().setArtist("foo").build();
+
+    assertThat(castPlayer.getPlaylistMetadata()).isEqualTo(MediaMetadata.EMPTY);
+
+    castPlayer.setPlaylistMetadata(metadata);
+
+    assertThat(castPlayer.getPlaylistMetadata()).isEqualTo(metadata);
+
+    verify(mockListener).onPlaylistMetadataChanged(metadata);
+  }
+
+  @Test
+  public void setPlaylistMetadata_equalMetadata_doesNotNotifyOnPlaylistMetadataChanged() {
+    castPlayer.addListener(mockListener);
+
+    MediaMetadata metadata = new MediaMetadata.Builder().setArtist("foo").build();
+
+    castPlayer.setPlaylistMetadata(metadata);
+    castPlayer.setPlaylistMetadata(metadata);
+
+    assertThat(castPlayer.getPlaylistMetadata()).isEqualTo(metadata);
+
+    verify(mockListener, times(1)).onPlaylistMetadataChanged(metadata);
+  }
+
   @Test
   public void getDeviceInfo_returnsCorrectDeviceInfoWithPlaybackTypeRemote() {
     DeviceInfo deviceInfo = castPlayer.getDeviceInfo();