io.scanbot.sdk.idcardscanner

Class IdCardScannerFrameHandler

io.scanbot.sdk.idcardscanner.IdCardScannerFrameHandler

public class IdCardScannerFrameHandler

Performs ID card data detection on camera preview frames. Outputs results via interface IdCardScannerFrameHandler.ResultHandler.

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

See Also:

interface IdCardScannerFrameHandler.ResultHandler, interface IdCardScannerFrameHandler.ResultHandler, addResultHandler

Field Detail

Companion

public static io.scanbot.sdk.idcardscanner.IdCardScannerFrameHandler.Companion Companion

Constructor Detail

IdCardScannerFrameHandler

public IdCardScannerFrameHandler(@NotNull
                                 IdCardScanner idCardScanner,
                                 boolean shouldRecognize)

Performs ID card data detection on camera preview frames. Outputs results via interface IdCardScannerFrameHandler.ResultHandler.

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

Parameters:

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

See Also:

interface IdCardScannerFrameHandler.ResultHandler, interface IdCardScannerFrameHandler.ResultHandler, addResultHandler

Method Detail

isEnabled

public boolean isEnabled()

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

Default is true

setEnabled

public void setEnabled(boolean p)

Parameter determines if ID card 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.idcardscanner.IdCardScannerFrameHandler.ResultHandler resultHandler)

Registers result handler which will be notified about ID card detection 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.idcardscanner.IdCardScannerFrameHandler.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 ID card scanner results.

attach

@JvmStatic
 @NotNull
public static IdCardScannerFrameHandler attach(@NotNull
                                                                    io.scanbot.sdk.ui.camera.IScanbotCameraView cameraView,
                                                                    @NotNull
                                                                    IdCardScanner idCardScanner,
                                                                    boolean shouldRecognize)

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

Parameters:

cameraView - cameraView to attach handler to

idCardScanner - scanner to perform ID card detection

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

See Also:

class IdCardScannerFrameHandler