Android Scanbot SDK API reference/io.scanbot.sdk.documentdata/DocumentDataExtractorFrameHandler

DocumentDataExtractorFrameHandler

class DocumentDataExtractorFrameHandler(documentDataExtractor: DocumentDataExtractor, documentDataExtractionMode: DocumentDataExtractionMode = DocumentDataExtractionMode.LIVE) : FrameHandler

Performs document extraction on camera preview frames. Outputs results via DocumentDataExtractorFrameHandler.ResultHandler.

Preview frame considered intercepted if at least one DocumentDataExtractorFrameHandler.ResultHandler returns true from DocumentDataExtractorFrameHandler.ResultHandler.handle

Parameters

documentDataExtractionMode

mode of extraction. Defaults to DocumentDataExtractionMode.LIVE

See also

Constructors

Link copied to clipboard
constructor(documentDataExtractor: DocumentDataExtractor, documentDataExtractionMode: DocumentDataExtractionMode = DocumentDataExtractionMode.LIVE)

Types

Link copied to clipboard
object Companion
Link copied to clipboard
abstract class DocumentDataExtractorResultHandler : DocumentDataExtractorFrameHandler.ResultHandler

Successor-class needed for cross-platform implementation

Link copied to clipboard
fun interface ResultHandler : BaseResultHandler<DocumentDataExtractionResult, SdkLicenseError>

Continuously notified about document data extraction results.

Functions

Link copied to clipboard
fun addResultHandler(resultHandler: DocumentDataExtractorFrameHandler.ResultHandler)

Registers result handler which will be notified about Document Data results.

Link copied to clipboard
fun clearResultHandlers()

Unregisters all handlers. If nothing was registered before, nothing happens.

Link copied to clipboard
@Synchronized
open override fun handleFrame(previewFrame: FrameHandler.Frame): Boolean

Invoked for every new camera preview frame.

Link copied to clipboard