Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 525c88c2 authored by Jaewan Kim's avatar Jaewan Kim Committed by Sungsoo Lim
Browse files

MediaSession2: Clean up TODOs under frameworks/base 

This change includes
  - Addressed trivial TODOs (takes less than 1min)
  - Renamed playlist controller to playlist agent
  - Renamed mplc to playlistAgent
  - Renamed mpb to player
  - Assigned buganizer issues for TODOs

Bug: 74361045
Test: Run MediaComponentsTest
Change-Id: I45e97081b5a3f24988c3daadd007edcb51be5288
parent 62ff4029

media/java/android/media/MediaController2.java

+15 −15
Original line number Diff line number Diff line
@@ -223,6 +223,7 @@ public class MediaController2 implements AutoCloseable { 
         * @see #onPositionChanged(MediaController2, long, long)

         * @see #onBufferedPositionChanged(MediaController2, long)

         */

        // TODO(jaewan): Use this (b/74316764)

        public void onCurrentMediaItemChanged(@NonNull MediaController2 controller,

                @NonNull MediaItem2 item) { }
@@ -230,43 +231,43 @@ public class MediaController2 implements AutoCloseable { 
         * Called when a playlist is changed.

         *

         * @param controller the controller for this event

         * @param mplc playlist controller for this event

         * @param playlistAgent playlist agent for this event

         * @param list new playlist

         * @param metadata new metadata

         */

        public void onPlaylistChanged(@NonNull MediaController2 controller,

                @NonNull MediaPlaylistAgent mplc, @NonNull List<MediaItem2> list,

                @NonNull MediaPlaylistAgent playlistAgent, @NonNull List<MediaItem2> list,

                @Nullable MediaMetadata2 metadata) { }



        /**

         * Called when a playlist metadata is changed.

         *

         * @param controller the controller for this event

         * @param mplc playlist controller for this event

         * @param playlistAgent playlist agent for this event

         * @param metadata new metadata

         */

        public void onPlaylistMetadataChanged(@NonNull MediaController2 controller,

                @NonNull MediaPlaylistAgent mplc, @Nullable MediaMetadata2 metadata) { }

                @NonNull MediaPlaylistAgent playlistAgent, @Nullable MediaMetadata2 metadata) { }



        /**

         * Called when the shuffle mode is changed.

         *

         * @param controller the controller for this event

         * @param mplc playlist controller for this event

         * @param playlistAgent playlist agent for this event

         * @param shuffleMode repeat mode

         * @see MediaPlaylistAgent#SHUFFLE_MODE_NONE

         * @see MediaPlaylistAgent#SHUFFLE_MODE_ALL

         * @see MediaPlaylistAgent#SHUFFLE_MODE_GROUP

         */

        public void onShuffleModeChanged(@NonNull MediaController2 controller,

                @NonNull MediaPlaylistAgent mplc,

                @NonNull MediaPlaylistAgent playlistAgent,

                @MediaPlaylistAgent.ShuffleMode int shuffleMode) { }



        /**

         * Called when the repeat mode is changed.

         *

         * @param controller the controller for this event

         * @param mplc playlist controller for this event

         * @param playlistAgent playlist agent for this event

         * @param repeatMode repeat mode

         * @see MediaPlaylistAgent#REPEAT_MODE_NONE

         * @see MediaPlaylistAgent#REPEAT_MODE_ONE
@@ -274,7 +275,7 @@ public class MediaController2 implements AutoCloseable { 
         * @see MediaPlaylistAgent#REPEAT_MODE_GROUP

         */

        public void onRepeatModeChanged(@NonNull MediaController2 controller,

                @NonNull MediaPlaylistAgent mplc,

                @NonNull MediaPlaylistAgent playlistAgent,

                @MediaPlaylistAgent.RepeatMode int repeatMode) { }



        /**
@@ -821,7 +822,9 @@ public class MediaController2 implements AutoCloseable { 
    }



    /**

     * Replace the media item at index in the playlist.

     * Replace the media item at index in the playlist. This can be also used to update metadata of

     * an item.

     *

     * @param index the index of the item to replace

     * @param item the new item

     */
@@ -836,8 +839,7 @@ public class MediaController2 implements AutoCloseable { 
     * @return index of the current item

     */

    public MediaItem2 getCurrentMediaItem() {

        // TODO(jaewan): Rename provider API

        return mProvider.getCurrentPlaylistItem_impl();

        return mProvider.getCurrentMediaItem_impl();

    }



    /**
@@ -852,13 +854,11 @@ public class MediaController2 implements AutoCloseable { 
    }



    public void skipToPreviousItem() {

        // TODO(jaewan): fix this

        mProvider.skipToPrevious_impl();

        mProvider.skipToPreviousItem_impl();

    }



    public void skipToNextItem() {

        // TODO(jaewan): fix this

        mProvider.skipToNext_impl();

        mProvider.skipToNextItem_impl();

    }



    public @RepeatMode int getRepeatMode() {

media/java/android/media/MediaLibraryService2.java

+2 −2
Original line number Diff line number Diff line
@@ -221,8 +221,8 @@ public abstract class MediaLibraryService2 extends MediaSessionService2 { 
            }



            @Override

            public Builder setPlaylistAgent(@NonNull MediaPlaylistAgent mplc) {

                return super.setPlaylistAgent(mplc);

            public Builder setPlaylistAgent(@NonNull MediaPlaylistAgent playlistAgent) {

                return super.setPlaylistAgent(playlistAgent);

            }



            @Override

media/java/android/media/MediaPlaylistAgent.java

+35 −36
Original line number Diff line number Diff line
@@ -103,56 +103,56 @@ public abstract class MediaPlaylistAgent { 
        /**

         * Called when a playlist is changed.

         *

         * @param mplc playlist controller for this event

         * @param playlistAgent playlist agent for this event

         * @param list new playlist

         * @param metadata new metadata

         */

        public void onPlaylistChanged(@NonNull MediaPlaylistAgent mplc,

        public void onPlaylistChanged(@NonNull MediaPlaylistAgent playlistAgent,

                @NonNull List<MediaItem2> list, @Nullable MediaMetadata2 metadata) { }



        /**

         * Called when a playlist metadata is changed.

         *

         * @param mplc playlist controller for this event

         * @param playlistAgent playlist agent for this event

         * @param metadata new metadata

         */

        public void onPlaylistMetadataChanged(@NonNull MediaPlaylistAgent mplc,

        public void onPlaylistMetadataChanged(@NonNull MediaPlaylistAgent playlistAgent,

                @Nullable MediaMetadata2 metadata) { }



        /**

         * Called when the shuffle mode is changed.

         *

         * @param mplc playlist controller for this event

         * @param playlistAgent playlist agent for this event

         * @param shuffleMode repeat mode

         * @see #SHUFFLE_MODE_NONE

         * @see #SHUFFLE_MODE_ALL

         * @see #SHUFFLE_MODE_GROUP

         */

        public void onShuffleModeChanged(@NonNull MediaPlaylistAgent mplc,

        public void onShuffleModeChanged(@NonNull MediaPlaylistAgent playlistAgent,

                @ShuffleMode int shuffleMode) { }



        /**

         * Called when the repeat mode is changed.

         *

         * @param mplc playlist controller for this event

         * @param playlistAgent playlist agent for this event

         * @param repeatMode repeat mode

         * @see #REPEAT_MODE_NONE

         * @see #REPEAT_MODE_ONE

         * @see #REPEAT_MODE_ALL

         * @see #REPEAT_MODE_GROUP

         */

        public void onRepeatModeChanged(@NonNull MediaPlaylistAgent mplc,

        public void onRepeatModeChanged(@NonNull MediaPlaylistAgent playlistAgent,

                @RepeatMode int repeatMode) { }

    }



    public MediaPlaylistAgent(Context context) {

    public MediaPlaylistAgent(@NonNull Context context) {

        // FYI, Need to have a context in the constructor for making this class be updatable

        // TODO(jaewan) : implement this

        // TODO(jaewan) : implement this (b/74090741)

    }



    /**

     * Register {@link PlaylistEventCallback} to listen changes in the underlying

     * {@link MediaPlaylistAgent}, regardless of the change in the controller.

     * {@link MediaPlaylistAgent}.

     *

     * @param executor a callback Executor

     * @param callback a PlaylistEventCallback
@@ -160,7 +160,7 @@ public abstract class MediaPlaylistAgent { 
     */

    public final void registerPlaylistEventCallback(

            @NonNull @CallbackExecutor Executor executor, @NonNull PlaylistEventCallback callback) {

        // TODO(jaewan): implement this

        // TODO(jaewan): implement this (b/74090741)

    }



    /**
@@ -171,23 +171,23 @@ public abstract class MediaPlaylistAgent { 
     */

    public final void unregisterPlaylistEventCallback(

            @NonNull PlaylistEventCallback callback) {

        // TODO(jaewan): implement this

        // TODO(jaewan): implement this (b/74090741)

    }



    public final void notifyPlaylistChanged() {

        // TODO(jaewan): implement this

        // TODO(jaewan): implement this (b/74090741)

    }



    public final void notifyPlaylistMetadataChanged() {

        // TODO(jaewan): implement this

        // TODO(jaewan): implement this (b/74090741)

    }



    public final void notifyShuffleModeChanged() {

        // TODO(jaewan): implement this

        // TODO(jaewan): implement this (b/74090741)

    }



    public final void notifyRepeatModeChanged() {

        // TODO(jaewan): implement this

        // TODO(jaewan): implement this (b/74090741)

    }



    /**
@@ -196,7 +196,7 @@ public abstract class MediaPlaylistAgent { 
     * @return playlist, or null if none is set.

     */

    public @Nullable List<MediaItem2> getPlaylist() {

        // TODO(jaewan): implement this

        // TODO(jaewan): implement this (b/74090741)

        return null;

    }
@@ -207,7 +207,7 @@ public abstract class MediaPlaylistAgent { 
     * @param metadata metadata of the playlist

     */

    public void setPlaylist(@NonNull List<MediaItem2> list, @Nullable MediaMetadata2 metadata) {

        // TODO(jaewan): implement this

        // TODO(jaewan): implement this (b/74090741)

    }



    /**
@@ -216,7 +216,7 @@ public abstract class MediaPlaylistAgent { 
     * @return metadata metadata of the playlist, or null if none is set

     */

    public @Nullable MediaMetadata2 getPlaylistMetadata() {

        // TODO(jaewan): implement this

        // TODO(jaewan): implement this (b/74090741)

        return null;

    }
@@ -226,7 +226,7 @@ public abstract class MediaPlaylistAgent { 
     * @param metadata metadata of the playlist

     */

    public void updatePlaylistMetadata(@Nullable MediaMetadata2 metadata) {

        // TODO(jaewan): implement this

        // TODO(jaewan): implement this (b/74090741)

    }



    /**
@@ -236,7 +236,7 @@ public abstract class MediaPlaylistAgent { 
     * @param item media item to add

     */

    public void addPlaylistItem(int index, @NonNull MediaItem2 item) {

        // TODO(jaewan): implement this

        // TODO(jaewan): implement this (b/74090741)

    }



    /**
@@ -245,19 +245,18 @@ public abstract class MediaPlaylistAgent { 
     * @param item media item to remove

     */

    public void removePlaylistItem(@NonNull MediaItem2 item) {

        // TODO(jaewan): implement this

        // TODO(jaewan): implement this (b/74090741)

    }



    /**

     * Replaces the media item with the .

     * <p>

     * This can be used to update metadata of a MediaItem.

     * Replace the media item at index in the playlist. This can be also used to update metadata of

     * an item.

     *

     * @param index index

     * @param item

     * @param index the index of the item to replace

     * @param item the new item

     */

    public void replacePlaylistItem(int index, @NonNull MediaItem2 item) {

        // TODO(jaewan): implement this

        // TODO(jaewan): implement this (b/74090741)

    }



    /**
@@ -266,15 +265,15 @@ public abstract class MediaPlaylistAgent { 
     * @param item media item to start playing from

     */

    public void skipToPlaylistItem(@NonNull MediaItem2 item) {

        // TODO(jaewan): implement this

        // TODO(jaewan): implement this (b/74090741)

    }



    public void skipToPreviousItem() {

        // TODO(jaewan): implement this

        // TODO(jaewan): implement this (b/74090741)

    }



    public void skipToNextItem() {

        // TODO(jaewan): implement this

        // TODO(jaewan): implement this (b/74090741)

    }



    /**
@@ -287,7 +286,7 @@ public abstract class MediaPlaylistAgent { 
     * @see #REPEAT_MODE_GROUP

     */

    public @RepeatMode int getRepeatMode() {

        // TODO(jaewan): implement this

        // TODO(jaewan): implement this (b/74090741)

        return REPEAT_MODE_NONE;

    }
@@ -301,7 +300,7 @@ public abstract class MediaPlaylistAgent { 
     * @see #REPEAT_MODE_GROUP

     */

    public void setRepeatMode(@RepeatMode int repeatMode) {

        // TODO(jaewan): implement this

        // TODO(jaewan): implement this (b/74090741)

    }



    /**
@@ -313,7 +312,7 @@ public abstract class MediaPlaylistAgent { 
     * @see #SHUFFLE_MODE_GROUP

     */

    public @ShuffleMode int getShuffleMode() {

        // TODO(jaewan): implement this

        // TODO(jaewan): implement this (b/74090741)

        return SHUFFLE_MODE_NONE;

    }
@@ -326,6 +325,6 @@ public abstract class MediaPlaylistAgent { 
     * @see #SHUFFLE_MODE_GROUP

     */

    public void setShuffleMode(@ShuffleMode int shuffleMode) {

        // TODO(jaewan): implement this

        // TODO(jaewan): implement this (b/74090741)

    }

}

media/java/android/media/MediaSession2.java

+85 −71

File changed.

Preview size limit exceeded, changes collapsed.

media/java/android/media/update/MediaController2Provider.java

+1 −1
Original line number Diff line number Diff line
@@ -70,7 +70,7 @@ public interface MediaController2Provider extends TransportControlProvider { 
    long getPosition_impl();

    float getPlaybackSpeed_impl();

    long getBufferedPosition_impl();

    MediaItem2 getCurrentPlaylistItem_impl();

    MediaItem2 getCurrentMediaItem_impl();



    interface PlaybackInfoProvider {

        int getPlaybackType_impl();