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

ScanbotSdkDocumentCleanup

class ScanbotSdkDocumentCleanup : ManuallyDisposable, DocumentCleanup

API for document cleanup.

Required licence feature(s): ImageProcessing.

Types

Companion

object Companion

Functions

canRedo

@Synchronized

open override fun canRedo(): Boolean

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

@Synchronized

open override 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

open override fun copyCurrentConfiguration(): DocumentCleanupConfiguration

Creates a copy of the current configuration value.

redo

@Synchronized

open override 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

@Synchronized

open override fun reset(): Result<ImageRef>

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

run

@Synchronized

open override fun run(mask: ImageRef): Result<DocumentCleanupResult>

cleans the masked areas up.

setConfiguration

@Synchronized

open override fun setConfiguration(image: ImageRef, configuration: DocumentCleanupConfiguration): Result<Unit>

Inplace reconfigures the API instance with new settings.

undo

@Synchronized

open override 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.