Class CheckScannerFrameHandler
-
- All Implemented Interfaces:
public final class CheckScannerFrameHandler extends FrameHandler
Performs check data scanning on camera preview frames. Outputs results via CheckScannerFrameHandler.ResultHandler (.addResultHandler).
Preview frame considered intercepted if at least one CheckScannerFrameHandler.ResultHandler returns
truefrom CheckScannerFrameHandler.ResultHandler.handle (FrameHandlerResult)}
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interfaceCheckScannerFrameHandler.ResultHandlerContinuously notified about check data detection results.
public abstract classCheckScannerFrameHandler.CheckScannerResultHandlerSuccessor-class needed for cross-platform implementation
-
Constructor Summary
Constructors Constructor Description CheckScannerFrameHandler(CheckScanner checkScanner)
-
Method Summary
Modifier and Type Method Description BooleanhandleFrame(FrameHandler.Frame previewFrame)Invoked for every new camera preview frame. final UnitaddResultHandler(CheckScannerFrameHandler.ResultHandler handler)Registers result handler which will be notified about check data detection results. final UnitremoveResultHandler(CheckScannerFrameHandler.ResultHandler handler)Unregisters handler. final UnitsetReturnFrameOnSuccess(Boolean returnFrameOnSuccess)Returns the frame in the scanning result on success. final static CheckScannerFrameHandlerattach(IScanbotCameraView cameraView, CheckScanner checkScanner)Convenience method for creating new CheckScannerFrameHandler and adding it as FrameHandler to given camera view. -
-
Constructor Detail
-
CheckScannerFrameHandler
CheckScannerFrameHandler(CheckScanner checkScanner)
-
-
Method Detail
-
handleFrame
@Synchronized() Boolean handleFrame(FrameHandler.Frame previewFrame)
Invoked for every new camera preview frame.
- Parameters:
previewFrame- captured preview frame data
-
addResultHandler
final Unit addResultHandler(CheckScannerFrameHandler.ResultHandler handler)
Registers result handler which will be notified about check 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.
-
removeResultHandler
final Unit removeResultHandler(CheckScannerFrameHandler.ResultHandler handler)
Unregisters handler.
- Parameters:
handler- handler to unregister.
-
setReturnFrameOnSuccess
final Unit setReturnFrameOnSuccess(Boolean returnFrameOnSuccess)
Returns the frame in the scanning result on success.
- Parameters:
returnFrameOnSuccess- if true camera frame will be returned in the scanning result, false - otherwise The default value is FALSE.
-
attach
final static CheckScannerFrameHandler attach(IScanbotCameraView cameraView, CheckScanner checkScanner)
Convenience method for creating new CheckScannerFrameHandler and adding it as FrameHandler to given camera view.
- Parameters:
cameraView- camera view to which new check data detector will be attached
-
-
-
-