net.doo.snap.payformscanner

Class PayFormScannerFrameHandler

java.lang.Object

net.doo.snap.payformscanner.PayFormScannerFrameHandler

All Implemented Interfaces:

PreviewBuffer.FrameHandler

public class PayFormScannerFrameHandler
extends java.lang.Object
implements PreviewBuffer.FrameHandler

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

Preview frame considered intercepted if at least one PayFormScannerFrameHandler.ResultHandler returns true from PayFormScannerFrameHandler.ResultHandler.handleResult(DetectionResult)

See Also:

PreviewBuffer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PayFormScannerFrameHandler.ResultHandler Continuously notified about pay form detection results.

Constructor Summary

Constructors

Constructor and Description
PayFormScannerFrameHandler(android.content.Context context, PayFormScanner payFormScanner)

Method Summary

Modifier and Type	Method and Description
void	addResultHandler(PayFormScannerFrameHandler.ResultHandler handler) Registers result handler which will be notified about pay form detection results.
static PayFormScannerFrameHandler	attach(ScanbotCameraView cameraView, PayFormScanner payFormScanner) Convenience method for creating new PayFormScannerFrameHandler and adding it as PreviewBuffer.FrameHandler to given camera view.
boolean	handleFrame(byte[] frame, int width, int height, int frameOrientation, android.graphics.Rect finderRect) Invoked for every new camera preview frame
boolean	isEnabled()
void	removeResultHandler(PayFormScannerFrameHandler.ResultHandler handler) Unregisters handler.
void	setEnabled(boolean enabled)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PayFormScannerFrameHandler

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

Method Detail

attach

public static PayFormScannerFrameHandler attach(ScanbotCameraView cameraView,
                                                PayFormScanner payFormScanner)

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

Parameters:

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

Returns:

new PayFormScannerFrameHandler

handleFrame

public boolean handleFrame(byte[] frame,
                           int width,
                           int height,
                           int frameOrientation,
                           android.graphics.Rect finderRect)

Description copied from interface: PreviewBuffer.FrameHandler

Invoked for every new camera preview frame

Specified by:

handleFrame in interface PreviewBuffer.FrameHandler

Parameters:

frame - image in NV21 format

width - width of the image

height - height of the image

frameOrientation - orientation of the image (in degrees)

finderRect - finder overlay area

Returns:

true if frame should be considered as "intercepted", i.e. no further processing should be performed on it. false to allow other frame handlers to process this frame.

addResultHandler

public void addResultHandler(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 already registered, nothing happens.

removeResultHandler

public void removeResultHandler(PayFormScannerFrameHandler.ResultHandler handler)

Unregisters handler.

Parameters:

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

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 enabled)

Parameters:

enabled - true to enable pay form detection. false to disable pay form detection.