DocumentScannerFrameHandler

All Implemented Interfaces:
```
public final class DocumentScannerFrameHandler
extends FrameHandler
                    
```
Performs document scanning on camera preview frames. Outputs results via DocumentScannerFrameHandler.ResultHandler (.addResultHandler).
Preview frame considered intercepted if at least one DocumentScannerFrameHandler.ResultHandler returns true from DocumentScannerFrameHandler.ResultHandler.handle (FrameHandlerResult)}

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public interface`	`DocumentScannerFrameHandler.ResultHandler`	Continuously notified about document scanning results.
`public abstract class`	`DocumentScannerFrameHandler.DocumentScannerResultHandler`	Successor-class needed for cross-platform implementation
`public final class`	`DocumentScannerFrameHandler.DetectedFrame`	Document scanning results alongside with information about frame

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description
`DocumentScannerFrameHandler(Context context, DocumentScanner documentScanner)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`Boolean`	`handleFrame(FrameHandler.Frame previewFrame)`	Invoked for every new camera preview frame.
`final Unit`	`addResultHandler(DocumentScannerFrameHandler.ResultHandler handler)`	Registers result handler which will be notified about document scanning results.
`final Unit`	`removeResultHandler(DocumentScannerFrameHandler.ResultHandler handler)`	Unregisters handler.
`final Unit`	`clearResultHandlers()`	Unregisters all handlers.
`final static DocumentScannerFrameHandler`	`attach(IScanbotCameraView cameraView, DocumentScanner detector)`	Convenience method for creating new DocumentScannerFrameHandler and adding it as FrameHandler to given camera view.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DocumentScannerFrameHandler
```
DocumentScannerFrameHandler(Context context, DocumentScanner documentScanner)
```
- 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(DocumentScannerFrameHandler.ResultHandler handler)
```
    Registers result handler which will be notified about document scanning 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(DocumentScannerFrameHandler.ResultHandler handler)
```
    Unregisters handler.
    
    Parameters:
    
    handler - handler to unregister.
  - clearResultHandlers
```
 final Unit clearResultHandlers()
```
    Unregisters all handlers.
  - attach
```
 final static DocumentScannerFrameHandler attach(IScanbotCameraView cameraView, DocumentScanner detector)
```
    Convenience method for creating new DocumentScannerFrameHandler and adding it as FrameHandler to given camera view.
    
    Parameters:
    
    cameraView - camera view to which new document scanner will be attached
    
    detector - document scanner instance