Tuesday, March 3, 2015

How to CORRECTLY take a screenshot using Android MediaProjection API

With the MediaProjection API in Android 5.0 it is possible to: 
capture the contents of the main screen (the default display) into a Surface object, which your app can then send across the network
The process to capture the screen contents is described in MediaProjection API Demo. This demo uses a SurfaceView to show a miniature version of the device's screen creating a Droste effect. But the surface view is not very helpful to actually use the captured screen i.e you can not get the screen capture as an image or a video. If you need to capture the screen as an image you can use and ImageReader object and pass its surface to createVirtualDisplay() method.

The problem is that it is not very straight forward to get the captured screen from ImageReader object either. The image that you get from ImageReader is raw i.e it has stride pixels in the image buffer and you need to take care of them your self. There are many people out there having difficulties getting the image from an ImageReader e.g here, here and here. The solution described in some of these Stackoverflow posts does work but it reduces the image quality significantly and also it is a lot more work and therefore it is slow. 

Below I describe a simpler method to get the image from ImageReader once you have created a virtual display using the ImageReader's surface. For completeness sake I describe the steps for creating a virtual display as well but if you are familiar with them just skip to step 3.

Step 1
To capture the screen contents you need a MediaProjection object. But first you need the user's permission to capture the screen using following code:
MediaProjectionManager projectionManager = (MediaProjectionManager) getSystemService(Context.MEDIA_PROJECTION_SERVICE);startActivityForResult(projectionManager.createScreenCaptureIntent(), PERMISSION_CODE);
This will start a dialog activity to ask user for permission to capture the display contents. 

Step 2
Once user allows screen capture, we can get a MediaProjection object in the onActivityResult() method using the following code.
MediaProjectionManager projectionManager = (MediaProjectionManager) getSystemService(Context.MEDIA_PROJECTION_SERVICE);
mProjection = projectionManager.getMediaProjection(resultCode, data);
The "data" passed to getMediaProjection() call is the intent data passed to onActivityResult() method. 

Step 3
The call to create a virtual display takes width and height of the virtual display and a surface object which will be used to save the device's screen. To the capture the screen as an image or a series of images we use surface of an ImageReader object. Create an ImageReader object as follows:
mImageReader = ImageReader.newInstance(mWidth, mHeight, ImageFormat.RGB_565, 2);
Step 4
Once we have the MediaProjection and ImageReader objects, we can start capturing screen by creating a virtual display using following code:
mProjection.createVirtualDisplay("screen-mirror", mWidth, mHeight, mDensity, flags, mImageReader.getSurface(), null, null);
Step 5
Now we can get the screen capture as image using the following code.
final Image.Plane[] planes = image.getPlanes();
final ByteBuffer buffer = planes[0].getBuffer();
int offset = 0;
int pixelStride = planes[0].getPixelStride();
int rowStride = planes[0].getRowStride();
int rowPadding = rowStride - pixelStride * mWidth;
// create bitmap
Bitmap bmp = Bitmap.createBitmap(mWidth+rowPadding/pixelStride, mHeight, Bitmap.Config.RGB_565);
now the bitmap object bmp has the your screen capture in correct format and you can simply use Bitmap.compress() method to convert it to JPEG, PNG or WEBP format. 
The error that most people make here is that they create bitmap of the wrong size, they create bitmap of same width and height as the virtual display but the problem is that the image you get from ImageReader has some extra pixels in there on each line. So you need to account for those as well when creating the bitmap to copy the pixel data. Therefore when creating bitmap I am passing "mWidth+rowPadding/pixelStride" as width. This is for sake of clarity so it is easy to understand otherwise you can instead pass "rowStride/pixelStride".


Manos said...


I have used code similar to your to capture the screen in Android 5.0. I had a problem in that the user can at any point stop projection by manually going to the notification bar and ending it. Is there a callback so that my app can identify such events and act accordingly? I tried using MediaProjection.Callback but with no success.

Unknown said...

using the method you outlined but I'm still getting the extra size on the right edge of the screen shot. Anything else I need to do?

Bitmap __bmp = Bitmap.createBitmap(__rowStride/__pixelStride, __height, Bitmap.Config.ARGB_8888);

Unknown said...

I have implemented as you suggested by I am getting black images having sizes 2-3 KB, please can you share your code or can help??

Thanks and regards

Unknown said...

What about `flags`? What flags are we supposed to use to capture what's on the screen?

I used `VIRTUAL_DISPLAY_FLAG_AUTO_MIRROR` and I get images of height and width as "-1".

Unknown said...

When MediaProjection permission dialog screen comes up, MainActivity is being called how can we prevent it
I am sorry for my English

Unknown said...

Hey his is not a reply but have u found the solution to this problem I am currently facing the same problem

Unknown said...

Very helpful, thanks for sharing the code.

Angel Claudia said...

We are among the best online companies providing affordable nursing essay writing services. When you nursing writing services, you get the services of experts and specialists in your field.

meldaresearch said...

You need not to worry any more,we are here to offer you the best academic writing
solutions;order quality pre written research papers for sale from us today!

leahmelda@gmail.com said...

Online Biology Paper Writing Services produces different assignments, including Buy Essay Online Services, to help students deal with the Buy Business Reports challenges they face every day.

Ivymelda said...

Medicine Essay Writing are the most outstanding in the writing industry, enabling you to achieve the best Thesis Writing Services. Also the professional writers’ commitments to delivering the top Medicine Essay Writing Services.

Legitimate Custom Research Paper Services said...

You should take some time and evaluate the Custom Essay Writing Services and Cheap Custom Essay Services as most students buy Affordable Online Essay For Sale and get ripped off

London Tigers Security said...

I am thanks for the article post. looking forward to visiting more. London Tigers Security Door Supervisor

Farnek UK said...

Great work I always try to share good information. Farnek.uk

Hot Pics said...

Japanese Celebrities Hot Images, Hot Photos, Hot Pics just visit this website given below.

Hot Pics

Check Mot History said...

Greetings! The very helpful advice in this particular blog post! Providing Us With This Great Knowledge Check Mot History Online

assignmentauthors said...

My aim here is to find out more about the registrations systems that re performed online in some three separate universities getting to understand how efficient these systems of registrations are together with the challenges facing them before coming up with a permanent and long lasting solution. assignment expert

The Tech Helpers said...

Shashka has all the party supplies you need, all in one place, all year long. For birthdays and beyond, no matter what you’re celebrating, this online portal has everything you could ever want when you’re throwing the best party ever. The ease and convenience of the site makes planning and shopping for your party almost as fun as having it! With hundreds of the highest-quality party supplies for all ages and occasions, Shashka.pk is the place to be.

Smart Research USA said...

We all know the main trouble of every student is lack of time! That's why you need to visit this site Homework Help Writing Services As well as this site Assignment Writing Services Online The Website also offers Online Research Paper Services at an affordable cost.

Katherine Flintoff said...

Lahore Smart City is going to be the best choice for commercial, investment and residential point of view. The scheme will have everything to attract national and international investors. In return, investors will get high revenue. On the other hand, the housing society is equipped with state of the art facilities. The facilities are just dream of come true for the people of Lahore. Peace, safety and eco-friendly behaviors Future Development Holding hires and corporate’s with world-class developers, architectures and planners. This Smart City Lahore will have golf clubs and fields designed by experienced and world-recognized designers.

Hosthook Official said...

Are you looking for Cheap Hosting Services Provider Company? Do not worry because Hosthook is one of the leading and famous Web Hosting Services Provider Company in the World. So what are you waiting for just visit our website and choose your ideal package.