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

ScreenCapture

public final class ScreenCapture

A ScreenCapture contains a bitmap of a device screen along with a set of ScreenCaptureProcessors that will be used to process the ScreenCapture when is called.

If no ScreenCaptureProcessors are added to the list the BasicScreenCaptureProcessor is used when process is called.

If a set of processors are supplied with the call to process then those processors will take precedence over the set of global processors and the BasicScreenCaptureProcessor.

This API is currently in beta.

Summary

Public methods
@NonNull boolean
@NonNull Bitmap

Returns the Bitmap that was set when the ScreenCapture was created.
@NonNull CompressFormat

Returns the format to save the bitmap as or PNG if none has been set.
@NonNull String

Returns the filename to save the bitmap as or null if none has been set.
@NonNull int
@NonNull void

Process the ScreenCapture using the global set of ScreenCaptureProcessors or the BasicScreenCaptureProcessor if no processors are set.
@NonNull void

Process the ScreenCapture using the given set of ScreenCaptureProcessors or the BasicScreenCaptureProcessor if no processors are in the given set.
@NonNull ScreenCapture
setFormat(@NonNull CompressFormat format)

Sets the format to save the ScreenCapture as.
@NonNull ScreenCapture
setName(@NonNull String filename)

Sets the filename to save the ScreenCapture as.

Public methods

equals

@NonNull
public boolean equals(@NonNull Object obj)

getBitmap

@NonNull
public Bitmap getBitmap()

Returns the Bitmap that was set when the ScreenCapture was created.

getFormat

@NonNull
public CompressFormat getFormat()

Returns the format to save the bitmap as or PNG if none has been set.

getName

@NonNull
public String getName()

Returns the filename to save the bitmap as or null if none has been set.

hashCode

@NonNull
public int hashCode()

process

@NonNull
public void process()

Process the ScreenCapture using the global set of ScreenCaptureProcessors or the BasicScreenCaptureProcessor if no processors are set.

Throws
java.io.IOException

if there is an IOException while any of the processors are processing the ScreenCapture

process

@NonNull
public void process(@NonNull Set<@NonNull ScreenCaptureProcessor> processorSet)

Process the ScreenCapture using the given set of ScreenCaptureProcessors or the BasicScreenCaptureProcessor if no processors are in the given set.

Parameters
@NonNull Set<@NonNull ScreenCaptureProcessor> processorSet

the set of processors to use to process the ScreenCapture
Throws
java.io.IOException

if there is an IOException while any of the processors are processing the ScreenCapture

setFormat

@NonNull
public ScreenCapture setFormat(@NonNull CompressFormat format)

Sets the format to save the ScreenCapture as.

Parameters
@NonNull CompressFormat format

the format to use to save the screenshot as
Returns
ScreenCapture

a fluent interface

setName

@NonNull
public ScreenCapture setName(@NonNull String filename)

Sets the filename to save the ScreenCapture as.

Parameters
@NonNull String filename

the filename to use to save the capture as
Returns
ScreenCapture

a fluent interface