Android Scanbot SDK/io.scanbot.sdk.imageprocessing/DocumentCleanup

DocumentCleanup

interface DocumentCleanup : AutoCloseable

Interface for DocumentCleanup API. See class documentation for more details.

Inheritors

Functions

Returns whether a redo operation is currently available. This is true when at least one undo operation has been performed and not yet overwritten by a new cleanup.

canUndo

abstract fun canUndo(): Boolean

Returns whether an undo operation is currently available. This is true when at least one cleanup operation has been performed and not yet fully undone.

copyCurrentConfiguration

abstract fun copyCurrentConfiguration(): DocumentCleanupConfiguration

Creates a copy of the current configuration value.

redo

abstract fun redo(): Result<ImageRef>

Re-applies the last undone cleanup operation. If no operations are available to redo, returns the current image unchanged. Performing a new cleanup operation after undo will clear the redo history.

reset

abstract fun reset(): Result<ImageRef>

Restores the original image, and clears the undo/redo history. After reset, both canUndo and canRedo return false.

run

abstract fun run(mask: ImageRef): Result<DocumentCleanupResult>

cleans the masked areas up.

setConfiguration

abstract fun setConfiguration(image: ImageRef, configuration: DocumentCleanupConfiguration = DocumentCleanupConfiguration( )): Result<Unit>

Inplace reconfigures the API instance with new settings.

undo

abstract fun undo(): Result<ImageRef>

Reverts the last cleanup operation. If no operations are available to undo, returns the current image unchanged. The number of available undo operations is limited by maxUndoRedoStackSize. When the operation limit is exceeded, the oldest operations cannot be undone.