{% setvar book_path %}/reference/kotlin/androidx/_book.yaml{% endsetvar %} {% include "_shared/_reference-head-tags.html" %}
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.
Public constructors |
|
|---|---|
Public functions |
|
|---|---|
String! |
process(capture: ScreenCapture!)Process the given |
Protected functions |
|
|---|---|
String! |
Returns the default filename for this class suffixed with a UUID. |
String! |
getFilename(prefix: String!)Returns the filename created from the given prifix and suffixed with a UUID. |
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 |
| Returns | |
|---|---|
String! |
the filename the bitmap was saved as |
| Throws | |
|---|---|
java.io.IOException: java.io.IOException |
if there was an I/O error saving the screenshot |
protected fun getDefaultFilename(): String!
Returns the default filename for this class suffixed with a UUID.
protected fun getFilename(prefix: String!): String!
Returns the filename created from the given prifix and suffixed with a UUID.