ScreenCapture

class ScreenCapture


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

If no ScreenCaptureProcessors are added to the list the 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 .

Summary

Public functions

Boolean
equals(obj: Any!)
String!

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

Int
Unit

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

Unit

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

ScreenCapture!
setName(filename: String!)

Sets the filename to save the ScreenCapture as.

Public functions

equals

fun equals(obj: Any!): Boolean

getName

fun getName(): String!

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

hashCode

fun hashCode(): Int

process

fun process(): Unit

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

fun process(processorSet: (Mutable)Set<ScreenCaptureProcessor!>): Unit

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

Parameters
processorSet: (Mutable)Set<ScreenCaptureProcessor!>

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

setName

fun setName(filename: String!): ScreenCapture!

Sets the filename to save the ScreenCapture as.

Parameters
filename: String!

the filename to use to save the capture as

Returns
ScreenCapture!

a fluent interface

Public properties

bitmap

val bitmapBitmap!

format

var formatBitmap.CompressFormat!