All Implemented Interfaces:
```
public final class DocumentDataExtractorFrameHandler
extends FrameHandler
                    
```
Performs document extraction on camera preview frames. Outputs results via DocumentDataExtractorFrameHandler.ResultHandler.
Preview frame considered intercepted if at least one DocumentDataExtractorFrameHandler.ResultHandler returns true from DocumentDataExtractorFrameHandler.ResultHandler.handle

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public interface`	`DocumentDataExtractorFrameHandler.ResultHandler`	Continuously notified about document data extraction results.
`public abstract class`	`DocumentDataExtractorFrameHandler.DocumentDataExtractorResultHandler`	Successor-class needed for cross-platform implementation

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description
`DocumentDataExtractorFrameHandler(DocumentDataExtractor documentDataExtractor, DocumentDataExtractionMode documentDataExtractionMode)`

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(DocumentDataExtractorFrameHandler.ResultHandler resultHandler)`	Registers result handler which will be notified about Document Data results.
`final Unit`	`removeResultHandler(DocumentDataExtractorFrameHandler.ResultHandler resultHandler)`	Unregisters handler.
`final Unit`	`clearResultHandlers()`	Unregisters all handlers.
`final static DocumentDataExtractorFrameHandler`	`attach(IScanbotCameraView cameraView, DocumentDataExtractor documentDataExtractor, DocumentDataExtractionMode documentDataExtractionMode)`	Convenience method for creating new DocumentDataExtractorFrameHandler 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
  - DocumentDataExtractorFrameHandler
```
DocumentDataExtractorFrameHandler(DocumentDataExtractor documentDataExtractor, DocumentDataExtractionMode documentDataExtractionMode)
```
    Parameters:
    
    documentDataExtractionMode - mode of extraction.
- 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(DocumentDataExtractorFrameHandler.ResultHandler resultHandler)
```
    Registers result handler which will be notified about Document Data results.
    Results are coming on the worker thread. Don't forget to move execution to main thread before updating UI.
    
    Parameters:
    
    resultHandler - handler to register.
  - removeResultHandler
```
 final Unit removeResultHandler(DocumentDataExtractorFrameHandler.ResultHandler resultHandler)
```
    Unregisters handler.
    
    Parameters:
    
    resultHandler - handler to unregister.
  - clearResultHandlers
```
 final Unit clearResultHandlers()
```
    Unregisters all handlers. If nothing was registered before, nothing happens.
  - attach
```
 final static DocumentDataExtractorFrameHandler attach(IScanbotCameraView cameraView, DocumentDataExtractor documentDataExtractor, DocumentDataExtractionMode documentDataExtractionMode)
```
    Convenience method for creating new DocumentDataExtractorFrameHandler and adding it as FrameHandler to given camera view.
    
    Parameters:
    
    cameraView - cameraView to attach handler to
    
    documentDataExtractor - extractor instance to perform document scanning
    
    documentDataExtractionMode - mode of extraction.

Class DocumentDataExtractorFrameHandler

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DocumentDataExtractorFrameHandler

Method Detail

handleFrame

addResultHandler

removeResultHandler

clearResultHandlers

attach