{% setvar book_path %}/reference/kotlin/androidx/_book.yaml{% endsetvar %} {% include "_shared/_reference-head-tags.html" %}

Screenshot

class Screenshot

The Screenshot instance provides methods to capture a ScreenCapture during instrumentation tests run on an android device.

The Screenshot instance keeps track of a set of ScreenCaptureProcessors that will be passed to each ScreenCapture object when they are created during any test. These ScreenCaptureProcessors are capable of processing the ScreenCapture that was created.

This API is currently in beta.

Summary

Nested types
Screenshot.ScreenShotException

An Exception associated with failing to capture a screenshot.

Public constructors

Public functions
Unit
addScreenCaptureProcessors(
    screenCaptureProcessors: Set<ScreenCaptureProcessor>
)

Adds the given set of ScreenCaptureProcessors to the current set of ScreenCaptureProcessors.
ScreenCapture

Creates a ScreenCapture that contains a Bitmap of the visible screen content for Build.VERSION_CODES.JELLY_BEAN_MR2 and above.
ScreenCapture
capture(activity: Activity)

Creates a ScreenCapture that contains a Bitmap of the given activity's root View hierarchy content.
ScreenCapture
capture(view: View)

Creates a ScreenCapture that contains a Bitmap of the given view's hierarchy content.
Unit
setScreenshotProcessors(
    screenCaptureProcessors: Set<ScreenCaptureProcessor>
)

Sets the current set of ScreenCaptureProcessors to the given set of ScreenCaptureProcessors.

Public constructors

Screenshot

Screenshot()

Public functions

addScreenCaptureProcessors

fun addScreenCaptureProcessors(
    screenCaptureProcessors: Set<ScreenCaptureProcessor>
): Unit

Adds the given set of ScreenCaptureProcessors to the current set of ScreenCaptureProcessors.

The current set of ScreenCaptureProcessors will be passed to each ScreenCapture that is created.

Parameters
screenCaptureProcessors: Set<ScreenCaptureProcessor>

the set of ScreenCaptureProcessors to add

capture

fun capture(): ScreenCapture

Creates a ScreenCapture that contains a Bitmap of the visible screen content for Build.VERSION_CODES.JELLY_BEAN_MR2 and above.

The ScreenCapture that is returned will also contain the set of ScreenCaptureProcessors that have been set in this instance.

Note: Only use this method if all your tests run on API versions Build.VERSION_CODES.JELLY_BEAN_MR2 or above. If you need to take screenshots on lower API levels, you need to use capture or capture for those versions.

Returns
ScreenCapture

a ScreenCapture that contains the bitmap of the visible screen content.
Throws
java.lang.IllegalStateException

if used on API below Build.VERSION_CODES.JELLY_BEAN_MR2
androidx.test.runner.screenshot.Screenshot.ScreenShotException

If there was an error capturing the screenshot

capture

fun capture(activity: Activity): ScreenCapture

Creates a ScreenCapture that contains a Bitmap of the given activity's root View hierarchy content.

The ScreenCapture that is returned will also contain the set of ScreenCaptureProcessors that have been set in this instance.

Parameters
activity: Activity

the Activity who's root View will be used to create a Bitmap
Returns
ScreenCapture

a ScreenCapture that contains the bitmap of the given activity's root View.
Throws
java.lang.NullPointerException

if given activity is null
androidx.test.runner.screenshot.Screenshot.ScreenShotException

If there was an error capturing the screenshot

capture

fun capture(view: View): ScreenCapture

Creates a ScreenCapture that contains a Bitmap of the given view's hierarchy content.

The ScreenCapture that is returned will also contain the set of ScreenCaptureProcessors that have been set in this instance.

Parameters
view: View

the View to create a Bitmap of
Returns
ScreenCapture

ScreenCapture that contains the bitmap of the given view's hierarchy content.
Throws
java.lang.NullPointerException

if given view is null
androidx.test.runner.screenshot.Screenshot.ScreenShotException

If there was an error capturing the screenshot

setScreenshotProcessors

fun setScreenshotProcessors(
    screenCaptureProcessors: Set<ScreenCaptureProcessor>
): Unit

Sets the current set of ScreenCaptureProcessors to the given set of ScreenCaptureProcessors.

The current set of ScreenCaptureProcessors will be passed to each ScreenCapture that is created.

Parameters
screenCaptureProcessors: Set<ScreenCaptureProcessor>

the set of ScreenCaptureProcessors to use