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

BasicScreenCaptureProcessor

class BasicScreenCaptureProcessor : ScreenCaptureProcessor

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

Public constructors

Public functions
String

Process the given ScreenCapture.

Public constructors

BasicScreenCaptureProcessor

BasicScreenCaptureProcessor()

Public functions

process

fun process(capture: ScreenCapture): String

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
java.io.IOException

if there was an I/O error saving the screenshot