com.apple.android.music.playback.controller

Interface MediaPlayerController.Listener

Enclosing interface:

MediaPlayerController

public static interface MediaPlayerController.Listener

An interface defining callbacks that a media player controller calls on registered listeners.

Method Summary

Modifier and Type	Method and Description
void	onAvailableTracksChanged(MediaPlayerController playerController, Set<com.apple.android.music.playback.model.MediaPlayerTrackInfo> tracks) Callback indicating that the available tracks for the currently playing item has changed.
void	onBufferingStateChanged(MediaPlayerController playerController, boolean buffering) The buffering state changed for the specified media player controller.
void	onCurrentItemChanged(MediaPlayerController playerController, PlayerQueueItem previousItem, PlayerQueueItem currentItem) The current item changed for the specified media player controller because of a new loaded queue, a user skip, or the end of the previous item.
void	onItemEnded(MediaPlayerController playerController, PlayerQueueItem queueItem, long endPosition) Playback ended for the specified item because the media ended or because of a skip or stop action.
void	onMetadataUpdated(MediaPlayerController playerController, PlayerQueueItem currentItem) An updated state for the currently playing item’s metadata, usually during a live stream.
void	onPlaybackError(MediaPlayerController playerController, MediaPlayerException error) An error occurred during playback.
void	onPlaybackQueueChanged(MediaPlayerController playerController, List<PlayerQueueItem> playbackQueueItems) A user changed the items in the current playback queue.
void	onPlaybackQueueItemsAdded(MediaPlayerController playerController, int queueInsertionType, int containerType, int itemType) A user added items to the playback queue.
void	onPlaybackRepeatModeChanged(MediaPlayerController playerController, int currentRepeatMode) A user changed the current repeat mode.
void	onPlaybackShuffleModeChanged(MediaPlayerController playerController, int currentShuffleMode) A user changed the current shuffle mode.
void	onPlaybackStateChanged(MediaPlayerController playerController, int previousState, int currentState) The playback state changed for the specified media player controller.
void	onPlaybackStateUpdated(MediaPlayerController playerController) An update to the current playback state data occurred.
void	onPlayerStateRestored(MediaPlayerController playerController) The specified media player controller finished loading any previously saved state.
void	onVideoSizeChanged(MediaPlayerController playerController, int videoWidth, int videoHeight, float videoPixelAspectRatio) Callback indicating that the size of the currently playing video (if applicable) has changed.

Method Detail

onAvailableTracksChanged

void onAvailableTracksChanged(@NonNull
                              MediaPlayerController playerController,
                              @NonNull
                              Set<com.apple.android.music.playback.model.MediaPlayerTrackInfo> tracks)

Callback indicating that the available tracks for the currently playing item has changed.

Parameters:

playerController - A MediaPlayerController instance.

tracks - The set of available tracks for the current item.

onBufferingStateChanged

void onBufferingStateChanged(@NonNull
                             MediaPlayerController playerController,
                             boolean buffering)

The buffering state changed for the specified media player controller.

Parameters:

playerController - A MediaPlayerController instance.

buffering - True if the player is currently buffering, false otherwise.

onCurrentItemChanged

void onCurrentItemChanged(@NonNull
                          MediaPlayerController playerController,
                          @Nullable
                          PlayerQueueItem previousItem,
                          @Nullable
                          PlayerQueueItem currentItem)

The current item changed for the specified media player controller because of a new loaded queue, a user skip, or the end of the previous item.

Parameters:

playerController - A MediaPlayerController instance.

previousItem - The previous item, or null.

currentItem - The current item, or null.

onItemEnded

void onItemEnded(@NonNull
                 MediaPlayerController playerController,
                 @NonNull
                 PlayerQueueItem queueItem,
                 long endPosition)

Playback ended for the specified item because the media ended or because of a skip or stop action.

Parameters:

playerController - A MediaPlayerController instance.

queueItem - The item which has completed playback.

endPosition - The position, in milliseconds, that the playhead was at when the item ended.

onMetadataUpdated

void onMetadataUpdated(@NonNull
                       MediaPlayerController playerController,
                       @NonNull
                       PlayerQueueItem currentItem)

An updated state for the currently playing item’s metadata, usually during a live stream.

Parameters:

playerController - A MediaPlayerController instance.

currentItem - The current item with updated metadata.

onPlaybackError

void onPlaybackError(@NonNull
                     MediaPlayerController playerController,
                     @NonNull
                     MediaPlayerException error)

An error occurred during playback.

Parameters:

playerController - A MediaPlayerController instance.

error - The error that occurred.

onPlaybackQueueChanged

void onPlaybackQueueChanged(@NonNull
                            MediaPlayerController playerController,
                            @NonNull
                            List<PlayerQueueItem> playbackQueueItems)

A user changed the items in the current playback queue.

Parameters:

playerController - A MediaPlayerController instance.

playbackQueueItems - A list of PlayerQueueItems representing the current state of the playback queue.

onPlaybackQueueItemsAdded

void onPlaybackQueueItemsAdded(@NonNull
                               MediaPlayerController playerController,
                               int queueInsertionType,
                               int containerType,
                               int itemType)

A user added items to the playback queue.

Parameters:

playerController - A MediaPlayerController instance.

queueInsertionType - The queue insertion type used to add items to the playback queue.

containerType - The MediaContainerType for the items which were added to the playback queue.

itemType - The MediaItemType for the items which were added to the playback queue.

onPlaybackRepeatModeChanged

void onPlaybackRepeatModeChanged(@NonNull
                                 MediaPlayerController playerController,
                                 int currentRepeatMode)

A user changed the current repeat mode.

Parameters:

playerController - A MediaPlayerController instance.

currentRepeatMode - The current repeat mode.

onPlaybackShuffleModeChanged

void onPlaybackShuffleModeChanged(@NonNull
                                  MediaPlayerController playerController,
                                  int currentShuffleMode)

A user changed the current shuffle mode.

Parameters:

playerController - A MediaPlayerController instance.

currentShuffleMode - The current shuffle mode.

onPlaybackStateChanged

void onPlaybackStateChanged(@NonNull
                            MediaPlayerController playerController,
                            int previousState,
                            int currentState)

The playback state changed for the specified media player controller.

Parameters:

playerController - A MediaPlayerController instance.

previousState - The previous PlaybackState.

currentState - The current PlaybackState.

onPlaybackStateUpdated

void onPlaybackStateUpdated(@NonNull
                            MediaPlayerController playerController)

An update to the current playback state data occurred.

Parameters:

playerController - A MediaPlayerController instance.

onPlayerStateRestored

void onPlayerStateRestored(@NonNull
                           MediaPlayerController playerController)

The specified media player controller finished loading any previously saved state.

Parameters:

playerController - A MediaPlayerController instance.

onVideoSizeChanged

void onVideoSizeChanged(@NonNull
                        MediaPlayerController playerController,
                        int videoWidth,
                        int videoHeight,
                        float videoPixelAspectRatio)

Callback indicating that the size of the currently playing video (if applicable) has changed. Values of 0 indicate that there is either currently no video, or no surface has been set for video output.

Parameters:

playerController - A MediaPlayerController instance.

videoWidth - The width of the video, or 0.

videoHeight - The height of the video, or 0.