# Screenshot

Artifact: [androidx.test:runner](https://developer.android.com/jetpack/androidx/releases/test) [View Source](https://cs.android.com/search?q=file:androidx/test/runner/screenshot/Screenshot.java+class:androidx.test.runner.screenshot.Screenshot)

*** ** * ** ***


```
class Screenshot
```

<br />

*** ** * ** ***

> [!CAUTION]
> **This class is deprecated.**   
>
> use androidx.test.espresso.screenshot.captureToBitmap or androidx.test.core.app.DeviceCapture instead

The Screenshot instance provides methods to capture a `https://developer.android.com/reference/kotlin/androidx/test/runner/screenshot/ScreenCapture` during instrumentation tests run on an android device.

The Screenshot instance keeps track of a set of `https://developer.android.com/reference/kotlin/androidx/test/runner/screenshot/ScreenCaptureProcessor`s that will be passed to each `https://developer.android.com/reference/kotlin/androidx/test/runner/screenshot/ScreenCapture` object when they are created during any test. These `https://developer.android.com/reference/kotlin/androidx/test/runner/screenshot/ScreenCaptureProcessor`s are capable of processing the `https://developer.android.com/reference/kotlin/androidx/test/runner/screenshot/ScreenCapture` that was created.

## Summary

| ### Nested types |
|---|
| `class https://developer.android.com/reference/kotlin/androidx/test/runner/screenshot/Screenshot.ScreenShotException : https://developer.android.com/reference/java/lang/RuntimeException.html` **This class is deprecated.** use androidx.test.espresso.screenshot.captureToBitmap or androidx.test.core.app.DeviceCapture instead <br /> |

| ### Public constructors |
|---|
| `[Screenshot](https://developer.android.com/reference/kotlin/androidx/test/runner/screenshot/Screenshot#Screenshot())()` **This function is deprecated.** Deprecated in Java |

| ### Public functions |
|---|---|
| `java-static https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `[addScreenCaptureProcessors](https://developer.android.com/reference/kotlin/androidx/test/runner/screenshot/Screenshot#addScreenCaptureProcessors(java.util.Set<androidx.test.runner.screenshot.ScreenCaptureProcessor>))( screenCaptureProcessors: (https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-mutable-set/index.html)https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-set/index.html<https://developer.android.com/reference/kotlin/androidx/test/runner/screenshot/ScreenCaptureProcessor!>! )` **This function is deprecated.** Deprecated in Java |
| `java-static https://developer.android.com/reference/kotlin/androidx/test/runner/screenshot/ScreenCapture!` | `[capture](https://developer.android.com/reference/kotlin/androidx/test/runner/screenshot/Screenshot#capture())()` **This function is deprecated.** Deprecated in Java |
| `java-static https://developer.android.com/reference/kotlin/androidx/test/runner/screenshot/ScreenCapture!` | `[capture](https://developer.android.com/reference/kotlin/androidx/test/runner/screenshot/Screenshot#capture(android.app.Activity))(activity: https://developer.android.com/reference/android/app/Activity.html)` **This function is deprecated.** Deprecated in Java |
| `java-static https://developer.android.com/reference/kotlin/androidx/test/runner/screenshot/ScreenCapture!` | `[capture](https://developer.android.com/reference/kotlin/androidx/test/runner/screenshot/Screenshot#capture(android.view.View))(view: https://developer.android.com/reference/android/view/View.html)` **This function is deprecated.** Deprecated in Java |
| `java-static https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `[setScreenshotProcessors](https://developer.android.com/reference/kotlin/androidx/test/runner/screenshot/Screenshot#setScreenshotProcessors(java.util.Set<androidx.test.runner.screenshot.ScreenCaptureProcessor>))( screenCaptureProcessors: (https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-mutable-set/index.html)https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-set/index.html<https://developer.android.com/reference/kotlin/androidx/test/runner/screenshot/ScreenCaptureProcessor!>! )` **This function is deprecated.** Deprecated in Java |

## Public constructors

### Screenshot

```
[Screenshot](https://developer.android.com/reference/kotlin/androidx/test/runner/screenshot/Screenshot#Screenshot())()
```

> [!CAUTION]
> **This function is deprecated.**   
> Deprecated in Java

## Public functions

### addScreenCaptureProcessors

```
java-static fun [addScreenCaptureProcessors](https://developer.android.com/reference/kotlin/androidx/test/runner/screenshot/Screenshot#addScreenCaptureProcessors(java.util.Set<androidx.test.runner.screenshot.ScreenCaptureProcessor>))(
    screenCaptureProcessors: (Mutable)Set<ScreenCaptureProcessor!>!
): Unit
```

> [!CAUTION]
> **This function is deprecated.**   
> Deprecated in Java

Adds the given set of `https://developer.android.com/reference/kotlin/androidx/test/runner/screenshot/ScreenCaptureProcessor`s to the current set of `https://developer.android.com/reference/kotlin/androidx/test/runner/screenshot/ScreenCaptureProcessor`s.

The current set of `https://developer.android.com/reference/kotlin/androidx/test/runner/screenshot/ScreenCaptureProcessor`s will be passed to each `https://developer.android.com/reference/kotlin/androidx/test/runner/screenshot/ScreenCapture` that is created.

| Parameters |
|---|---|
| `screenCaptureProcessors: (https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-mutable-set/index.html)https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-set/index.html<https://developer.android.com/reference/kotlin/androidx/test/runner/screenshot/ScreenCaptureProcessor!>!` | the set of `https://developer.android.com/reference/kotlin/androidx/test/runner/screenshot/ScreenCaptureProcessor`s to add |

### capture

```
java-static fun [capture](https://developer.android.com/reference/kotlin/androidx/test/runner/screenshot/Screenshot#capture())(): ScreenCapture!
```

> [!CAUTION]
> **This function is deprecated.**   
> Deprecated in Java

Creates a `https://developer.android.com/reference/kotlin/androidx/test/runner/screenshot/ScreenCapture` that contains a `https://developer.android.com/reference/android/graphics/Bitmap.html` of the visible screen content.

The `https://developer.android.com/reference/kotlin/androidx/test/runner/screenshot/ScreenCapture` that is returned will also contain the set of `https://developer.android.com/reference/kotlin/androidx/test/runner/screenshot/ScreenCaptureProcessor`s that have been set in this instance.

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/test/runner/screenshot/ScreenCapture!` | a `https://developer.android.com/reference/kotlin/androidx/test/runner/screenshot/ScreenCapture` that contains the bitmap of the visible screen content. |

| Throws |
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalStateException.html` | if used on API below Build.VERSION_CODES.JELLY_BEAN_MR2 |
| `https://developer.android.com/reference/kotlin/androidx/test/runner/screenshot/Screenshot.ScreenShotException` | If there was an error capturing the screenshot |

### capture

```
java-static fun [capture](https://developer.android.com/reference/kotlin/androidx/test/runner/screenshot/Screenshot#capture(android.app.Activity))(activity: Activity): ScreenCapture!
```

> [!CAUTION]
> **This function is deprecated.**   
> Deprecated in Java

Creates a `https://developer.android.com/reference/kotlin/androidx/test/runner/screenshot/ScreenCapture` that contains a `https://developer.android.com/reference/android/graphics/Bitmap.html` of the given activity's root `https://developer.android.com/reference/android/view/View.html` hierarchy content.

The `https://developer.android.com/reference/kotlin/androidx/test/runner/screenshot/ScreenCapture` that is returned will also contain the set of `https://developer.android.com/reference/kotlin/androidx/test/runner/screenshot/ScreenCaptureProcessor`s that have been set in this instance.

| Parameters |
|---|---|
| `activity: https://developer.android.com/reference/android/app/Activity.html` | the `https://developer.android.com/reference/android/app/Activity.html` who's root `https://developer.android.com/reference/android/view/View.html` will be used to create a `https://developer.android.com/reference/android/graphics/Bitmap.html` |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/test/runner/screenshot/ScreenCapture!` | a `https://developer.android.com/reference/kotlin/androidx/test/runner/screenshot/ScreenCapture` that contains the bitmap of the given activity's root `https://developer.android.com/reference/android/view/View.html`. |

| Throws |
|---|---|
| `https://developer.android.com/reference/java/lang/NullPointerException.html` | if given activity is null |
| `https://developer.android.com/reference/kotlin/androidx/test/runner/screenshot/Screenshot.ScreenShotException` | If there was an error capturing the screenshot |

### capture

```
java-static fun [capture](https://developer.android.com/reference/kotlin/androidx/test/runner/screenshot/Screenshot#capture(android.view.View))(view: View): ScreenCapture!
```

> [!CAUTION]
> **This function is deprecated.**   
> Deprecated in Java

Creates a `https://developer.android.com/reference/kotlin/androidx/test/runner/screenshot/ScreenCapture` that contains a `https://developer.android.com/reference/android/graphics/Bitmap.html` of the given view's hierarchy content.

The `https://developer.android.com/reference/kotlin/androidx/test/runner/screenshot/ScreenCapture` that is returned will also contain the set of `https://developer.android.com/reference/kotlin/androidx/test/runner/screenshot/ScreenCaptureProcessor`s that have been set in this instance.

| Parameters |
|---|---|
| `view: https://developer.android.com/reference/android/view/View.html` | the `https://developer.android.com/reference/android/view/View.html` to create a `https://developer.android.com/reference/android/graphics/Bitmap.html` of |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/test/runner/screenshot/ScreenCapture!` | `https://developer.android.com/reference/kotlin/androidx/test/runner/screenshot/ScreenCapture` that contains the bitmap of the given view's hierarchy content. |

| Throws |
|---|---|
| `https://developer.android.com/reference/java/lang/NullPointerException.html` | if given view is null |
| `https://developer.android.com/reference/kotlin/androidx/test/runner/screenshot/Screenshot.ScreenShotException` | If there was an error capturing the screenshot |

### setScreenshotProcessors

```
java-static fun [setScreenshotProcessors](https://developer.android.com/reference/kotlin/androidx/test/runner/screenshot/Screenshot#setScreenshotProcessors(java.util.Set<androidx.test.runner.screenshot.ScreenCaptureProcessor>))(
    screenCaptureProcessors: (Mutable)Set<ScreenCaptureProcessor!>!
): Unit
```

> [!CAUTION]
> **This function is deprecated.**   
> Deprecated in Java

Sets the current set of `https://developer.android.com/reference/kotlin/androidx/test/runner/screenshot/ScreenCaptureProcessor`s to the given set of `https://developer.android.com/reference/kotlin/androidx/test/runner/screenshot/ScreenCaptureProcessor`s.

The current set of `https://developer.android.com/reference/kotlin/androidx/test/runner/screenshot/ScreenCaptureProcessor`s will be passed to each `https://developer.android.com/reference/kotlin/androidx/test/runner/screenshot/ScreenCapture` that is created.

| Parameters |
|---|---|
| `screenCaptureProcessors: (https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-mutable-set/index.html)https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-set/index.html<https://developer.android.com/reference/kotlin/androidx/test/runner/screenshot/ScreenCaptureProcessor!>!` | the set of `https://developer.android.com/reference/kotlin/androidx/test/runner/screenshot/ScreenCaptureProcessor`s to use |