io.scanbot.sdk.genericdocument

Class GenericDocumentRecognizerFrameHandler

io.scanbot.sdk.genericdocument.GenericDocumentRecognizerFrameHandler

public class GenericDocumentRecognizerFrameHandler

Performs document recognition on camera preview frames. Outputs results via interface GenericDocumentRecognizerFrameHandler.ResultHandler.

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

See Also:

interface GenericDocumentRecognizerFrameHandler.ResultHandler, interface GenericDocumentRecognizerFrameHandler.ResultHandler, addResultHandler

Field Detail

Companion

public static io.scanbot.sdk.genericdocument.GenericDocumentRecognizerFrameHandler.Companion Companion

Constructor Detail

GenericDocumentRecognizerFrameHandler

public GenericDocumentRecognizerFrameHandler(@NotNull
                                             GenericDocumentRecognizer genericDocumentRecognizer,
                                             boolean shouldRecognize)

Performs document recognition on camera preview frames. Outputs results via interface GenericDocumentRecognizerFrameHandler.ResultHandler.

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

Parameters:

shouldRecognize - whether to recognize field and their data on ID card. Defaults to true

See Also:

interface GenericDocumentRecognizerFrameHandler.ResultHandler, interface GenericDocumentRecognizerFrameHandler.ResultHandler, addResultHandler

Method Detail

isEnabled

public boolean isEnabled()

Parameter determines if document detection is enabled. In case of false value incoming frames are skipped.

Default is true

setEnabled

public void setEnabled(boolean p)

Parameter determines if document detection is enabled. In case of false value incoming frames are skipped.

Default is true

handleFrame

@Synchronized
public boolean handleFrame(@NotNull
                                         io.scanbot.sdk.camera.FrameHandler.Frame previewFrame)

addResultHandler

public void addResultHandler(@NotNull
                             io.scanbot.sdk.genericdocument.GenericDocumentRecognizerFrameHandler.ResultHandler resultHandler)

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

Results are coming on the worker thread. Don't forget to move execution to main thread before updating UI.

Parameters:

resultHandler - handler to register. Must not be null. If handler was alreadyregistered, nothing happens.

removeResultHandler

public void removeResultHandler(@NotNull
                                io.scanbot.sdk.genericdocument.GenericDocumentRecognizerFrameHandler.ResultHandler resultHandler)

Unregisters handler.

Parameters:

resultHandler - handler to unregister. If it was not registered before, nothing happens.

clearResultHandlers

public void clearResultHandlers()

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

<no name provided>

public void <no name provided>()

Continuously notified about document recognition results.

attach

@JvmStatic
 @NotNull
public static GenericDocumentRecognizerFrameHandler attach(@NotNull
                                                                                io.scanbot.sdk.ui.camera.IScanbotCameraView cameraView,
                                                                                @NotNull
                                                                                GenericDocumentRecognizer genericDocumentRecognizer,
                                                                                boolean shouldRecognize)

Convenience method for creating new class GenericDocumentRecognizerFrameHandler and adding it as FrameHandler to given camera view.

Parameters:

cameraView - cameraView to attach handler to

genericDocumentRecognizer - recognizer instance to perform document detection

shouldRecognize - whether to recognize fields on documents. Defaults to true

See Also:

class GenericDocumentRecognizerFrameHandler