io.scanbot.sdk.payformscanner

Class PayFormScannerFrameHandler

io.scanbot.sdk.payformscanner.PayFormScannerFrameHandler

public class PayFormScannerFrameHandler

Performs pay form detection on camera preview frames. Outputs results via interface PayFormScannerFrameHandler.ResultHandler (.addResultHandler).

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

See Also:

interface PayFormScannerFrameHandler.ResultHandler, .addResultHandler, interface PayFormScannerFrameHandler.ResultHandler

Field Detail

Companion

public static io.scanbot.sdk.payformscanner.PayFormScannerFrameHandler.Companion Companion

Constructor Detail

PayFormScannerFrameHandler

public PayFormScannerFrameHandler(@NotNull
                                  PayFormScanner payFormScanner)

Performs pay form detection on camera preview frames. Outputs results via interface PayFormScannerFrameHandler.ResultHandler (.addResultHandler).

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

See Also:

interface PayFormScannerFrameHandler.ResultHandler, .addResultHandler, interface PayFormScannerFrameHandler.ResultHandler

PayFormScannerFrameHandler

@Deprecated
public PayFormScannerFrameHandler(@NotNull
                                              android.content.Context context,
                                              @NotNull
                                              PayFormScanner payFormScanner)

Deprecated.

Method Detail

isEnabled

public boolean isEnabled()

Returns:

true if pay form detection is enabled. false if pay form detection is disabled, i.e. incoming frames are skipped.

setEnabled

public void setEnabled(boolean p)

handleFrame

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

addResultHandler

public void addResultHandler(@NotNull
                             io.scanbot.sdk.payformscanner.PayFormScannerFrameHandler.ResultHandler handler)

Registers result handler which will be notified about pay form detection results.

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

Parameters:

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

removeResultHandler

public void removeResultHandler(@NotNull
                                io.scanbot.sdk.payformscanner.PayFormScannerFrameHandler.ResultHandler handler)

Unregisters handler.

Parameters:

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

<no name provided>

public void <no name provided>()

Continuously notified about pay form detection results.

attach

@JvmStatic
 @NotNull
public static PayFormScannerFrameHandler attach(@NotNull
                                                                     io.scanbot.sdk.ui.camera.IScanbotCameraView cameraView,
                                                                     @NotNull
                                                                     PayFormScanner payFormScanner)

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

Parameters:

cameraView - camera view to which new pay form detector will be attached

Returns:

new class PayFormScannerFrameHandler

See Also:

class PayFormScannerFrameHandler