io.scanbot.sdk.barcode

Class BarcodeDetectorFrameHandler

java.lang.Object

io.scanbot.sdk.barcode.BarcodeDetectorFrameHandler

All Implemented Interfaces:

PreviewBuffer.FrameHandler

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

Performs barcode/QR code detection on camera preview frames. Outputs results via BarcodeDetectorFrameHandler.ResultHandler (addResultHandler(ResultHandler)).

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

See Also:

PreviewBuffer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BarcodeDetectorFrameHandler.ResultHandler Continiously notified about barcode/QR code detection results.

Constructor Summary

Constructors

Constructor and Description
BarcodeDetectorFrameHandler(android.content.Context context, ScanbotSDK scanbotSDK)

Method Summary

Modifier and Type	Method and Description
void	addResultHandler(BarcodeDetectorFrameHandler.ResultHandler handler) Registers result handler which will be notified about barcode/QR code detection results.
static BarcodeDetectorFrameHandler	attach(ScanbotCameraView cameraView, ScanbotSDK scanbotSDK) Convenience method for creating new BarcodeDetectorFrameHandler 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(BarcodeDetectorFrameHandler.ResultHandler handler) Unregisters handler.
void	setBarcodeFormatsFilter(java.util.List<BarcodeFormat> barcodeFormats) Sets List BarcodeFormat to scan
void	setDetectionInterval(long detectionIntervalInMs) Set barcode detection interval in milliseconds
void	setEnabled(boolean enabled)

Methods inherited from class java.lang.Object

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

Constructor Detail

BarcodeDetectorFrameHandler

public BarcodeDetectorFrameHandler(android.content.Context context,
                                   ScanbotSDK scanbotSDK)

Method Detail

attach

public static BarcodeDetectorFrameHandler attach(ScanbotCameraView cameraView,
                                                 ScanbotSDK scanbotSDK)

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

Parameters:

cameraView - camera view to which new barcode/QR code detector will be attached

Returns:

new BarcodeDetectorFrameHandler

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

Registers result handler which will be notified about barcode/QR code 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(BarcodeDetectorFrameHandler.ResultHandler handler)

Unregisters handler.

Parameters:

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

isEnabled

public boolean isEnabled()

Returns:

true if barcode/QR code detection is enabled. false if barcode/QR code detection is disabled, i.e. incoming frames are skipped.

setEnabled

public void setEnabled(boolean enabled)

Parameters:

enabled - true to enable barcode/QR code detection. false to disable barcode/QR code detection.

setDetectionInterval

public void setDetectionInterval(long detectionIntervalInMs)

Set barcode detection interval in milliseconds

Parameters:

detectionIntervalInMs -

setBarcodeFormatsFilter

public void setBarcodeFormatsFilter(java.util.List<BarcodeFormat> barcodeFormats)

Sets List BarcodeFormat to scan

Parameters:

barcodeFormats -