public class

BasicScreenCaptureProcessor

extends Object
implements ScreenCaptureProcessor
java.lang.Object
   ↳ androidx.test.runner.screenshot.BasicScreenCaptureProcessor

Class Overview

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.
[Expand]
Inherited Methods
From class java.lang.Object
From interface androidx.test.runner.screenshot.ScreenCaptureProcessor

Fields

protected String mDefaultFilenamePrefix

protected File mDefaultScreenshotPath

protected String mFileNameDelimiter

protected String mTag

Public Constructors

public BasicScreenCaptureProcessor ()

Public Methods

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

protected String getDefaultFilename ()

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

Returns
String

protected String getFilename (String prefix)

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

Parameters
prefix String
Returns
String