1 2 Android PictureInPicture Sample 3 =================================== 4 5 This sample demonstrates basic usage of Picture-in-Picture mode for handheld devices. 6 The sample plays a video. The video keeps on playing when the app is turned in to 7 Picture-in-Picture mode. On Picture-in-Picture screen, the app shows an action item to 8 pause or resume the video. 9 10 Introduction 11 ------------ 12 13 As of Android O, activities can launch in [Picture-in-Picture (PiP)][1] mode. PiP is a 14 special type of [multi-window][2] mode mostly used for video playback. 15 16 The app is *paused* when it enters PiP mode, but it should continue showing content. For this 17 reason, you should make sure your app does not pause playback in its [onPause()][3] 18 handler. Instead, you should pause video in [onStop()][4]. For more information, see [Multi-Window 19 Lifecycle][5]. 20 21 To specify that your activity can use PIP mode, set `android:supportsPictureInPicture` to `true` in 22 the manifest. (Beginning with Android O, you do not need to set 23 `android:resizeableActivity` to `true` if you are supporting PIP mode you only need to 24 `setrandroid:resizeableActivity` if your activity supports other multi-window modes.) 25 26 You can pass a [PictureInPictureParams][6] to [enterPictureInPictureMode()][7] to specify how an 27 activity should behave when it is in PiP mode. You can also use it to call 28 [setPictureInPictureParams()][8] and update the current behavior. If the app is in not PiP mode, it 29 will be used for later call of [enterPictureInPictureMode()][7]. 30 31 With a [PictureInPictureParams][6], you can specify aspect ratio of PiP activity and action items 32 available for PiP mode. The aspect ratio is used when the activity is in PiP mode. The action items 33 are used as menu items in PiP mode. You can use a [PendingIntent][9] to specify what to do when the 34 item is selected. 35 36 [1]: https://developer.android.com/guide/topics/ui/picture-in-picture.html 37 [2]: https://developer.android.com/guide/topics/ui/multi-window.html 38 [3]: https://developer.android.com/reference/android/app/Activity.html#onPause() 39 [4]: https://developer.android.com/reference/android/app/Activity.html#onStop() 40 [5]: https://developer.android.com/guide/topics/ui/multi-window.html#lifecycle 41 [6]: https://developer.android.com/reference/android/app/PictureInPictureParams.html 42 [7]: https://developer.android.com/reference/android/app/Activity.html#enterPictureInPictureMode(android.app.PictureInPictureParams) 43 [8]: https://developer.android.com/reference/android/app/Activity.html#setPictureInPictureParams(android.app.PictureInPictureParams) 44 [9]: https://developer.android.com/reference/android/app/PendingIntent.html 45 46 Pre-requisites 47 -------------- 48 49 - Android SDK 27 50 - Android Build Tools v27.0.2 51 - Android Support Repository 52 53 Screenshots 54 ------------- 55 56 <img src="screenshots/1-main.png" height="400" alt="Screenshot"/> <img src="screenshots/2-pip.png" height="400" alt="Screenshot"/> 57 58 Getting Started 59 --------------- 60 61 This sample uses the Gradle build system. To build this project, use the 62 "gradlew build" command or use "Import Project" in Android Studio. 63 64 Support 65 ------- 66 67 - Google+ Community: https://plus.google.com/communities/105153134372062985968 68 - Stack Overflow: http://stackoverflow.com/questions/tagged/android 69 70 If you've found an error in this sample, please file an issue: 71 https://github.com/googlesamples/android-PictureInPicture 72 73 Patches are encouraged, and may be submitted by forking this project and 74 submitting a pull request through GitHub. Please see CONTRIBUTING.md for more details. 75 76 License 77 ------- 78 79 Copyright 2017 The Android Open Source Project, Inc. 80 81 Licensed to the Apache Software Foundation (ASF) under one or more contributor 82 license agreements. See the NOTICE file distributed with this work for 83 additional information regarding copyright ownership. The ASF licenses this 84 file to you under the Apache License, Version 2.0 (the "License"); you may not 85 use this file except in compliance with the License. You may obtain a copy of 86 the License at 87 88 http://www.apache.org/licenses/LICENSE-2.0 89 90 Unless required by applicable law or agreed to in writing, software 91 distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 92 WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 93 License for the specific language governing permissions and limitations under 94 the License. 95
