README.md
1Android ScreenCapture Sample
2===================================
3
4This sample demonstrates how to use Media Projection API to capture device screen in real time and
5show it on a SurfaceView.
6
7Introduction
8------------
9
10Media Projection API lets you capture the current screen through Surface.
11
12To start media projection, you need to get an instance of [MediaProjection][1]. For this, you have
13to call startActivityForResult with an Intent from
14[MediaProjectionManager.createScreenCaptureIntent()][2]. This shows a confirmation dialog to the
15user. When user confirms it, you will get a result code and data in onActivityResult, so pass those
16to [getMediaProjection][3].
17
18Once you get a MediaProjection, use [createVirtualDisplay][4] and bind it to a Surface.
19
20[1]: https://developer.android.com/reference/android/media/projection/MediaProjection.html
21[2]: https://developer.android.com/reference/android/media/projection/MediaProjectionManager.html#createScreenCaptureIntent()
22[3]: https://developer.android.com/reference/android/media/projection/MediaProjectionManager.html#getMediaProjection(int, android.content.Intent)
23[4]: https://developer.android.com/reference/android/media/projection/MediaProjection.html#createVirtualDisplay(java.lang.String, int, int, int, int, android.view.Surface, android.hardware.display.VirtualDisplay.Callback, android.os.Handler)
24
25Pre-requisites
26--------------
27
28- Android SDK v21
29- Android Build Tools v21.1.1
30- Android Support Repository
31
32Screenshots
33-------------
34
35<img src="screenshots/main.png" height="400" alt="Screenshot"/>
36
37Getting Started
38---------------
39
40This sample uses the Gradle build system. To build this project, use the
41"gradlew build" command or use "Import Project" in Android Studio.
42
43Support
44-------
45
46- Google+ Community: https://plus.google.com/communities/105153134372062985968
47- Stack Overflow: http://stackoverflow.com/questions/tagged/android
48
49If you've found an error in this sample, please file an issue:
50https://github.com/googlesamples/android-ScreenCapture
51
52Patches are encouraged, and may be submitted by forking this project and
53submitting a pull request through GitHub. Please see CONTRIBUTING.md for more details.
54
55License
56-------
57
58Copyright 2014 The Android Open Source Project, Inc.
59
60Licensed to the Apache Software Foundation (ASF) under one or more contributor
61license agreements. See the NOTICE file distributed with this work for
62additional information regarding copyright ownership. The ASF licenses this
63file to you under the Apache License, Version 2.0 (the "License"); you may not
64use this file except in compliance with the License. You may obtain a copy of
65the License at
66
67http://www.apache.org/licenses/LICENSE-2.0
68
69Unless required by applicable law or agreed to in writing, software
70distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
71WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
72License for the specific language governing permissions and limitations under
73the License.
74