BasicScreenCaptureProcessor

public class BasicScreenCaptureProcessor
extends Object implements ScreenCaptureProcessor

java.lang.Object
   ↳ androidx.test.runner.screenshot.BasicScreenCaptureProcessor


A basic ScreenCaptureProcessor for processing a ScreenCapture.

This will perform basic processing on the given ScreenCapture such as saving to the public Pictures directory, given by android.os.Environment.getExternalStoragePublicDirectory(DIRECTORY_PICTURES), with a simple name that includes a few characteristics about the device it was saved on followed by a UUID.

This API is currently in beta.

Summary

Fields

protected String mDefaultFilenamePrefix

protected File mDefaultScreenshotPath

protected String mFileNameDelimiter

protected String mTag

Public constructors

BasicScreenCaptureProcessor()

Public methods

String process(ScreenCapture capture)

Process the given ScreenCapture.

Protected methods

String getDefaultFilename()

Returns the default filename for this class suffixed with a UUID.

String getFilename(String prefix)

Returns the filename created from the given prifix and suffixed with a UUID.

Inherited methods

Fields

mDefaultFilenamePrefix

protected String mDefaultFilenamePrefix

mDefaultScreenshotPath

protected File mDefaultScreenshotPath

mFileNameDelimiter

protected String mFileNameDelimiter

mTag

protected String mTag

Public constructors

BasicScreenCaptureProcessor

public BasicScreenCaptureProcessor ()

Public methods

process

public String process (ScreenCapture capture)

Process the given ScreenCapture.

The given ScreenCapture defines optional properties like filename and format that should be respected when defining the behavior of this method.

Parameters
capture ScreenCapture: the ScreenCapture that specifies the bitmap to process

Returns
String the filename the bitmap was saved as

Throws
IOException

Protected methods

getDefaultFilename

protected String getDefaultFilename ()

Returns the default filename for this class suffixed with a UUID.

Returns
String

getFilename

protected String getFilename (String prefix)

Returns the filename created from the given prifix and suffixed with a UUID.

Parameters
prefix String

Returns
String