Rename PlaylistMediaMetadata to PlaylistMetadata in Player.

This affects the setter, getter and callback, as well as various
media 3 methods.

PiperOrigin-RevId: 382275672
This commit is contained in:
samrobinson 2021-06-30 12:26:33 +01:00 committed by Oliver Woodman
parent 764f9f20d6
commit 9013facdd7
9 changed files with 43 additions and 44 deletions

View File

@ -543,14 +543,14 @@ public final class CastPlayer extends BasePlayer {
} }
@Override @Override
public MediaMetadata getPlaylistMediaMetadata() { public MediaMetadata getPlaylistMetadata() {
// CastPlayer does not currently support metadata. // CastPlayer does not currently support metadata.
return MediaMetadata.EMPTY; return MediaMetadata.EMPTY;
} }
/** This method is not supported and does nothing. */ /** This method is not supported and does nothing. */
@Override @Override
public void setPlaylistMediaMetadata(MediaMetadata mediaMetadata) { public void setPlaylistMetadata(MediaMetadata mediaMetadata) {
// CastPlayer does not currently support metadata. // CastPlayer does not currently support metadata.
} }

View File

@ -349,13 +349,13 @@ public class ForwardingPlayer implements Player {
} }
@Override @Override
public MediaMetadata getPlaylistMediaMetadata() { public MediaMetadata getPlaylistMetadata() {
return player.getPlaylistMediaMetadata(); return player.getPlaylistMetadata();
} }
@Override @Override
public void setPlaylistMediaMetadata(MediaMetadata mediaMetadata) { public void setPlaylistMetadata(MediaMetadata mediaMetadata) {
player.setPlaylistMediaMetadata(mediaMetadata); player.setPlaylistMetadata(mediaMetadata);
} }
@Nullable @Nullable
@ -624,8 +624,8 @@ public class ForwardingPlayer implements Player {
} }
@Override @Override
public void onPlaylistMediaMetadataChanged(MediaMetadata mediaMetadata) { public void onPlaylistMetadataChanged(MediaMetadata mediaMetadata) {
eventListener.onPlaylistMediaMetadataChanged(mediaMetadata); eventListener.onPlaylistMetadataChanged(mediaMetadata);
} }
@Override @Override

View File

@ -162,7 +162,7 @@ public interface Player {
default void onMediaMetadataChanged(MediaMetadata mediaMetadata) {} default void onMediaMetadataChanged(MediaMetadata mediaMetadata) {}
/** Called when the playlist {@link MediaMetadata} changes. */ /** Called when the playlist {@link MediaMetadata} changes. */
default void onPlaylistMediaMetadataChanged(MediaMetadata mediaMetadata) {} default void onPlaylistMetadataChanged(MediaMetadata mediaMetadata) {}
/** /**
* Called when the player starts or stops loading the source. * Called when the player starts or stops loading the source.
@ -1102,7 +1102,7 @@ public interface Player {
EVENT_PLAYBACK_PARAMETERS_CHANGED, EVENT_PLAYBACK_PARAMETERS_CHANGED,
EVENT_AVAILABLE_COMMANDS_CHANGED, EVENT_AVAILABLE_COMMANDS_CHANGED,
EVENT_MEDIA_METADATA_CHANGED, EVENT_MEDIA_METADATA_CHANGED,
EVENT_PLAYLIST_MEDIA_METADATA_CHANGED, EVENT_PLAYLIST_METADATA_CHANGED,
EVENT_FAST_FORWARD_INCREMENT_CHANGED, EVENT_FAST_FORWARD_INCREMENT_CHANGED,
EVENT_REWIND_INCREMENT_CHANGED EVENT_REWIND_INCREMENT_CHANGED
}) })
@ -1142,8 +1142,8 @@ public interface Player {
int EVENT_AVAILABLE_COMMANDS_CHANGED = 14; int EVENT_AVAILABLE_COMMANDS_CHANGED = 14;
/** {@link #getMediaMetadata()} changed. */ /** {@link #getMediaMetadata()} changed. */
int EVENT_MEDIA_METADATA_CHANGED = 15; int EVENT_MEDIA_METADATA_CHANGED = 15;
/** {@link #getPlaylistMediaMetadata()} changed. */ /** {@link #getPlaylistMetadata()} changed. */
int EVENT_PLAYLIST_MEDIA_METADATA_CHANGED = 16; int EVENT_PLAYLIST_METADATA_CHANGED = 16;
/** {@link #getFastForwardIncrement()} changed. */ /** {@link #getFastForwardIncrement()} changed. */
int EVENT_FAST_FORWARD_INCREMENT_CHANGED = 17; int EVENT_FAST_FORWARD_INCREMENT_CHANGED = 17;
/** {@link #getRewindIncrement()} changed. */ /** {@link #getRewindIncrement()} changed. */
@ -1803,12 +1803,12 @@ public interface Player {
/** /**
* Returns the playlist {@link MediaMetadata}, as set by {@link * Returns the playlist {@link MediaMetadata}, as set by {@link
* #setPlaylistMediaMetadata(MediaMetadata)}, or {@link MediaMetadata#EMPTY} if not supported. * #setPlaylistMetadata(MediaMetadata)}, or {@link MediaMetadata#EMPTY} if not supported.
*/ */
MediaMetadata getPlaylistMediaMetadata(); MediaMetadata getPlaylistMetadata();
/** Sets the playlist {@link MediaMetadata}. */ /** Sets the playlist {@link MediaMetadata}. */
void setPlaylistMediaMetadata(MediaMetadata mediaMetadata); void setPlaylistMetadata(MediaMetadata mediaMetadata);
/** /**
* Returns the current manifest. The type depends on the type of media being played. May be null. * Returns the current manifest. The type depends on the type of media being played. May be null.

View File

@ -103,7 +103,7 @@ import java.util.concurrent.CopyOnWriteArraySet;
private boolean pauseAtEndOfMediaItems; private boolean pauseAtEndOfMediaItems;
private Commands availableCommands; private Commands availableCommands;
private MediaMetadata mediaMetadata; private MediaMetadata mediaMetadata;
private MediaMetadata playlistMediaMetadata; private MediaMetadata playlistMetadata;
private long fastForwardIncrementMs; private long fastForwardIncrementMs;
private long rewindIncrementMs; private long rewindIncrementMs;
@ -216,7 +216,7 @@ import java.util.concurrent.CopyOnWriteArraySet;
.add(COMMAND_SEEK_TO_MEDIA_ITEM) .add(COMMAND_SEEK_TO_MEDIA_ITEM)
.build(); .build();
mediaMetadata = MediaMetadata.EMPTY; mediaMetadata = MediaMetadata.EMPTY;
playlistMediaMetadata = MediaMetadata.EMPTY; playlistMetadata = MediaMetadata.EMPTY;
fastForwardIncrementMs = DEFAULT_FAST_FORWARD_INCREMENT_MS; fastForwardIncrementMs = DEFAULT_FAST_FORWARD_INCREMENT_MS;
rewindIncrementMs = DEFAULT_REWIND_INCREMENT_MS; rewindIncrementMs = DEFAULT_REWIND_INCREMENT_MS;
maskingWindowIndex = C.INDEX_UNSET; maskingWindowIndex = C.INDEX_UNSET;
@ -1043,20 +1043,20 @@ import java.util.concurrent.CopyOnWriteArraySet;
} }
@Override @Override
public MediaMetadata getPlaylistMediaMetadata() { public MediaMetadata getPlaylistMetadata() {
return playlistMediaMetadata; return playlistMetadata;
} }
@Override @Override
public void setPlaylistMediaMetadata(MediaMetadata playlistMediaMetadata) { public void setPlaylistMetadata(MediaMetadata playlistMetadata) {
checkNotNull(playlistMediaMetadata); checkNotNull(playlistMetadata);
if (playlistMediaMetadata.equals(this.playlistMediaMetadata)) { if (playlistMetadata.equals(this.playlistMetadata)) {
return; return;
} }
this.playlistMediaMetadata = playlistMediaMetadata; this.playlistMetadata = playlistMetadata;
listeners.sendEvent( listeners.sendEvent(
EVENT_PLAYLIST_MEDIA_METADATA_CHANGED, EVENT_PLAYLIST_METADATA_CHANGED,
listener -> listener.onPlaylistMediaMetadataChanged(this.playlistMediaMetadata)); listener -> listener.onPlaylistMetadataChanged(this.playlistMetadata));
} }
@Override @Override

View File

@ -1690,13 +1690,13 @@ public class SimpleExoPlayer extends BasePlayer
} }
@Override @Override
public MediaMetadata getPlaylistMediaMetadata() { public MediaMetadata getPlaylistMetadata() {
return player.getPlaylistMediaMetadata(); return player.getPlaylistMetadata();
} }
@Override @Override
public void setPlaylistMediaMetadata(MediaMetadata mediaMetadata) { public void setPlaylistMetadata(MediaMetadata mediaMetadata) {
player.setPlaylistMediaMetadata(mediaMetadata); player.setPlaylistMetadata(mediaMetadata);
} }
@Override @Override

View File

@ -770,12 +770,12 @@ public class AnalyticsCollector
} }
@Override @Override
public void onPlaylistMediaMetadataChanged(MediaMetadata playlistMediaMetadata) { public void onPlaylistMetadataChanged(MediaMetadata playlistMetadata) {
EventTime eventTime = generateCurrentPlayerMediaPeriodEventTime(); EventTime eventTime = generateCurrentPlayerMediaPeriodEventTime();
sendEvent( sendEvent(
eventTime, eventTime,
AnalyticsListener.EVENT_PLAYLIST_MEDIA_METADATA_CHANGED, AnalyticsListener.EVENT_PLAYLIST_METADATA_CHANGED,
listener -> listener.onPlaylistMediaMetadataChanged(eventTime, playlistMediaMetadata)); listener -> listener.onPlaylistMetadataChanged(eventTime, playlistMetadata));
} }
@Override @Override

View File

@ -171,7 +171,7 @@ public interface AnalyticsListener {
EVENT_PLAYBACK_PARAMETERS_CHANGED, EVENT_PLAYBACK_PARAMETERS_CHANGED,
EVENT_AVAILABLE_COMMANDS_CHANGED, EVENT_AVAILABLE_COMMANDS_CHANGED,
EVENT_MEDIA_METADATA_CHANGED, EVENT_MEDIA_METADATA_CHANGED,
EVENT_PLAYLIST_MEDIA_METADATA_CHANGED, EVENT_PLAYLIST_METADATA_CHANGED,
EVENT_FAST_FORWARD_INCREMENT_CHANGED, EVENT_FAST_FORWARD_INCREMENT_CHANGED,
EVENT_REWIND_INCREMENT_CHANGED, EVENT_REWIND_INCREMENT_CHANGED,
EVENT_LOAD_STARTED, EVENT_LOAD_STARTED,
@ -254,8 +254,8 @@ public interface AnalyticsListener {
int EVENT_AVAILABLE_COMMANDS_CHANGED = Player.EVENT_AVAILABLE_COMMANDS_CHANGED; int EVENT_AVAILABLE_COMMANDS_CHANGED = Player.EVENT_AVAILABLE_COMMANDS_CHANGED;
/** {@link Player#getMediaMetadata()} changed. */ /** {@link Player#getMediaMetadata()} changed. */
int EVENT_MEDIA_METADATA_CHANGED = Player.EVENT_MEDIA_METADATA_CHANGED; int EVENT_MEDIA_METADATA_CHANGED = Player.EVENT_MEDIA_METADATA_CHANGED;
/** {@link Player#getPlaylistMediaMetadata()} changed. */ /** {@link Player#getPlaylistMetadata()} changed. */
int EVENT_PLAYLIST_MEDIA_METADATA_CHANGED = Player.EVENT_PLAYLIST_MEDIA_METADATA_CHANGED; int EVENT_PLAYLIST_METADATA_CHANGED = Player.EVENT_PLAYLIST_METADATA_CHANGED;
/** {@link Player#getFastForwardIncrement()} changed. */ /** {@link Player#getFastForwardIncrement()} changed. */
int EVENT_FAST_FORWARD_INCREMENT_CHANGED = Player.EVENT_FAST_FORWARD_INCREMENT_CHANGED; int EVENT_FAST_FORWARD_INCREMENT_CHANGED = Player.EVENT_FAST_FORWARD_INCREMENT_CHANGED;
/** {@link Player#getRewindIncrement()} changed. */ /** {@link Player#getRewindIncrement()} changed. */
@ -701,10 +701,9 @@ public interface AnalyticsListener {
* Called when the playlist {@link MediaMetadata} changes. * Called when the playlist {@link MediaMetadata} changes.
* *
* @param eventTime The event time. * @param eventTime The event time.
* @param playlistMediaMetadata The playlist {@link MediaMetadata}. * @param playlistMetadata The playlist {@link MediaMetadata}.
*/ */
default void onPlaylistMediaMetadataChanged( default void onPlaylistMetadataChanged(EventTime eventTime, MediaMetadata playlistMetadata) {}
EventTime eventTime, MediaMetadata playlistMediaMetadata) {}
/** /**
* Called when a media source started loading data. * Called when a media source started loading data.

View File

@ -63,7 +63,7 @@ public class SimpleExoPlayerTest {
} }
@Test @Test
public void onPlaybackMediaMetadataChanged_calledWhenPlaybackMediaMetadataSet() { public void onPlaylistMetadataChanged_calledWhenPlaylistMetadataSet() {
SimpleExoPlayer player = SimpleExoPlayer player =
new SimpleExoPlayer.Builder(ApplicationProvider.getApplicationContext()).build(); new SimpleExoPlayer.Builder(ApplicationProvider.getApplicationContext()).build();
Player.Listener playerListener = mock(Player.Listener.class); Player.Listener playerListener = mock(Player.Listener.class);
@ -72,10 +72,10 @@ public class SimpleExoPlayerTest {
player.addAnalyticsListener(analyticsListener); player.addAnalyticsListener(analyticsListener);
MediaMetadata mediaMetadata = new MediaMetadata.Builder().setTitle("test").build(); MediaMetadata mediaMetadata = new MediaMetadata.Builder().setTitle("test").build();
player.setPlaylistMediaMetadata(mediaMetadata); player.setPlaylistMetadata(mediaMetadata);
verify(playerListener).onPlaylistMediaMetadataChanged(mediaMetadata); verify(playerListener).onPlaylistMetadataChanged(mediaMetadata);
verify(analyticsListener).onPlaylistMediaMetadataChanged(any(), eq(mediaMetadata)); verify(analyticsListener).onPlaylistMetadataChanged(any(), eq(mediaMetadata));
} }
@Test @Test

View File

@ -391,12 +391,12 @@ public class StubExoPlayer extends BasePlayer implements ExoPlayer {
} }
@Override @Override
public MediaMetadata getPlaylistMediaMetadata() { public MediaMetadata getPlaylistMetadata() {
throw new UnsupportedOperationException(); throw new UnsupportedOperationException();
} }
@Override @Override
public void setPlaylistMediaMetadata(MediaMetadata mediaMetadata) { public void setPlaylistMetadata(MediaMetadata mediaMetadata) {
throw new UnsupportedOperationException(); throw new UnsupportedOperationException();
} }