Switch branches/tags
Nothing to show
Find file History
Latest commit b3db8b0 Dec 8, 2017
Permalink
..
Failed to load latest commit information.
.google Auto-update Oct 11, 2017
app Auto-update Dec 8, 2017
gradle/wrapper Auto-update Dec 8, 2017
screenshots Auto-update May 17, 2017
CONTRIBUTING.md Auto-update May 17, 2017
LICENSE Auto-update May 17, 2017
NOTICE Auto-update May 17, 2017
README.md Auto-update Oct 11, 2017
build.gradle Auto-update Dec 8, 2017
gradle.properties Auto-update May 17, 2017
gradlew Auto-update May 17, 2017
gradlew.bat Auto-update May 17, 2017
proguard-rules.pro Auto-update May 17, 2017
settings.gradle Auto-update May 17, 2017

README.md

Android PictureInPicture Sample (Kotlin)

This sample demonstrates basic usage of Picture-in-Picture mode for handheld devices. The sample plays a video. The video keeps on playing when the app is turned in to Picture-in-Picture mode. On Picture-in-Picture screen, the app shows an action item to pause or resume the video.

Introduction

As of Android O, activities can launch in Picture-in-Picture (PiP) mode. PiP is a special type of multi-window mode mostly used for video playback.

The app is paused when it enters PiP mode, but it should continue showing content. For this reason, you should make sure your app does not pause playback in its onPause() handler. Instead, you should pause video in onStop(). For more information, see Multi-Window Lifecycle.

To specify that your activity can use PIP mode, set android:supportsPictureInPicture to true in the manifest. (Beginning with the O Developer Preview, you do not need to set android:resizeableActivity to true if you are supporting PIP mode, either on Android TV or on other Android devices; you only need to setrandroid:resizeableActivity if your activity supports other multi-window modes.)

You can pass a PictureInPictureParams to enterPictureInPictureMode() to specify how an activity should behave when it is in PiP mode. You can also use it to call setPictureInPictureParams() and update the current behavior. If the app is in not PiP mode, it will be used for later call of enterPictureInPictureMode().

With a PictureInPictureParams, you can specify aspect ratio of PiP activity and action items available for PiP mode. The aspect ratio is used when the activity is in PiP mode. The action items are used as menu items in PiP mode. You can use a PendingIntent to specify what to do when the item is selected.

Pre-requisites

  • Android SDK 26
  • Android Build Tools v26.0.2
  • Android Support Repository

Screenshots

Screenshot Screenshot

Getting Started

This sample uses the Gradle build system. To build this project, use the "gradlew build" command or use "Import Project" in Android Studio.

Support

If you've found an error in this sample, please file an issue: https://github.com/googlesamples/android-PictureInPicture

Patches are encouraged, and may be submitted by forking this project and submitting a pull request through GitHub. Please see CONTRIBUTING.md for more details.

License

Copyright 2017 The Android Open Source Project, Inc.

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.