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