net.doo.snap.mrzscanner

Class MRZScannerFrameHandler

java.lang.Object

net.doo.snap.mrzscanner.MRZScannerFrameHandler

All Implemented Interfaces:

PreviewBuffer.FrameHandler

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

Performs MRZ data detection on camera preview frames. Outputs results via MRZScannerFrameHandler.ResultHandler (addResultHandler(ResultHandler)).

Preview frame considered intercepted if at least one MRZScannerFrameHandler.ResultHandler returns true from MRZScannerFrameHandler.ResultHandler#handleResult(io.scanbot.mrzscanner.model.MRZRecognitionResult)

See Also:

PreviewBuffer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MRZScannerFrameHandler.ResultHandler Continuously notified about MRZ data detection results.

Constructor Summary

Constructors

Constructor and Description
MRZScannerFrameHandler(android.content.Context context, MRZScanner mrzScanner)

Method Summary

Modifier and Type	Method and Description
void	addResultHandler(MRZScannerFrameHandler.ResultHandler handler) Registers result handler which will be notified about MRZ data detection results.
static MRZScannerFrameHandler	attach(ScanbotCameraView cameraView, MRZScanner mrzScanner) Convenience method for creating new MRZScannerFrameHandler 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(MRZScannerFrameHandler.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

MRZScannerFrameHandler

public MRZScannerFrameHandler(android.content.Context context,
                              MRZScanner mrzScanner)

Method Detail

attach

public static MRZScannerFrameHandler attach(ScanbotCameraView cameraView,
                                            MRZScanner mrzScanner)

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

Parameters:

cameraView - camera view to which new MRZ data detector will be attached

Returns:

new MRZScannerFrameHandler

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(MRZScannerFrameHandler.ResultHandler handler)

Registers result handler which will be notified about MRZ data 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(MRZScannerFrameHandler.ResultHandler handler)

Unregisters handler.

Parameters:

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

isEnabled

public boolean isEnabled()

Returns:

true if MRZ data detection is enabled. false if MRZ data detection is disabled, i.e. incoming frames are skipped.

setEnabled

public void setEnabled(boolean enabled)

Parameters:

enabled - true to enable MRZ data detection. false to disable MRZ data detection.