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

Commit cd74270d authored by RoboErik's avatar RoboErik
Browse files

Document MediaSession.Callback.onMediaButtonEvent and add returns 

Documents the return value and makes sure it returns true where
appropriate.

bug:17289717
Change-Id: Ia831a7212b76e8434b745be70da2ed106fa01230
parent e545035e

media/java/android/media/session/MediaSession.java

+10 −0
Original line number Diff line number Diff line
@@ -683,6 +683,7 @@ public final class MediaSession { 
         *

         * @param mediaButtonIntent an intent containing the KeyEvent as an

         *            extra

         * @return True if the event was handled, false otherwise.

         */

        public boolean onMediaButtonEvent(@NonNull Intent mediaButtonIntent) {

            if (mSession != null
@@ -695,36 +696,43 @@ public final class MediaSession { 
                        case KeyEvent.KEYCODE_MEDIA_PLAY:

                            if ((validActions & PlaybackState.ACTION_PLAY) != 0) {

                                onPlay();

                                return true;

                            }

                            break;

                        case KeyEvent.KEYCODE_MEDIA_PAUSE:

                            if ((validActions & PlaybackState.ACTION_PAUSE) != 0) {

                                onPause();

                                return true;

                            }

                            break;

                        case KeyEvent.KEYCODE_MEDIA_NEXT:

                            if ((validActions & PlaybackState.ACTION_SKIP_TO_NEXT) != 0) {

                                onSkipToNext();

                                return true;

                            }

                            break;

                        case KeyEvent.KEYCODE_MEDIA_PREVIOUS:

                            if ((validActions & PlaybackState.ACTION_SKIP_TO_PREVIOUS) != 0) {

                                onSkipToPrevious();

                                return true;

                            }

                            break;

                        case KeyEvent.KEYCODE_MEDIA_STOP:

                            if ((validActions & PlaybackState.ACTION_STOP) != 0) {

                                onStop();

                                return true;

                            }

                            break;

                        case KeyEvent.KEYCODE_MEDIA_FAST_FORWARD:

                            if ((validActions & PlaybackState.ACTION_FAST_FORWARD) != 0) {

                                onFastForward();

                                return true;

                            }

                            break;

                        case KeyEvent.KEYCODE_MEDIA_REWIND:

                            if ((validActions & PlaybackState.ACTION_REWIND) != 0) {

                                onRewind();

                                return true;

                            }

                            break;

                        case KeyEvent.KEYCODE_MEDIA_PLAY_PAUSE:
@@ -737,8 +745,10 @@ public final class MediaSession { 
                                    | PlaybackState.ACTION_PAUSE)) != 0;

                            if (isPlaying && canPause) {

                                onPause();

                                return true;

                            } else if (!isPlaying && canPlay) {

                                onPlay();

                                return true;

                            }

                            break;

                    }