GenericTextRecognizerFrameHandler 1.84.1.165-SNAPSHOT API

All Implemented Interfaces:

io.scanbot.sdk.camera.FrameHandler
```
public final class GenericTextRecognizerFrameHandler
 implements FrameHandler
                    
```
Performs generic text recognition on camera preview frames. Outputs results via GenericTextRecognizerFrameHandler.ResultHandler.
Preview frame considered intercepted if at least one GenericTextRecognizerFrameHandler.ResultHandler returns true from GenericTextRecognizerFrameHandler.ResultHandler.handle

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public interface`	`GenericTextRecognizerFrameHandler.ResultHandler`	Continuously notified about generic text recognition results.
`public abstract class`	`GenericTextRecognizerFrameHandler.TextRecognitionScannerResultHandler`	Successor-class needed for cross-platform implementation
`public class`	`GenericTextRecognizerFrameHandler.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private Boolean`	`isEnabled`

Constructor Summary

Constructors
Constructor	Description
`GenericTextRecognizerFrameHandler(GenericTextRecognizer genericTextRecognizer)`

Method Summary

Modifier and Type	Method	Description
`final Boolean`	`getIsEnabled()`	Parameter determines if text recognition is enabled.
`final Unit`	`setIsEnabled(Boolean isEnabled)`	Parameter determines if text recognition is enabled.
`Boolean`	`handleFrame(FrameHandler.Frame previewFrame)`
`final Unit`	`addResultHandler(GenericTextRecognizerFrameHandler.ResultHandler resultHandler)`	Registers result handler which will be notified about generic text recognition results.
`final Unit`	`removeResultHandler(GenericTextRecognizerFrameHandler.ResultHandler resultHandler)`	Unregisters handler.
`final Unit`	`clearResultHandlers()`	Unregisters all handlers.

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

- Constructor Detail
  - GenericTextRecognizerFrameHandler
```
GenericTextRecognizerFrameHandler(GenericTextRecognizer genericTextRecognizer)
```
- Method Detail
  - getIsEnabled
```
 final Boolean getIsEnabled()
```
    Parameter determines if text recognition is enabled. In case of false value incoming frames are skipped.
    Default is true
  - setIsEnabled
```
 final Unit setIsEnabled(Boolean isEnabled)
```
    Parameter determines if text recognition is enabled. In case of false value incoming frames are skipped.
    Default is true
  - handleFrame
```
@Synchronized() Boolean handleFrame(FrameHandler.Frame previewFrame)
```
  - addResultHandler
```
 final Unit addResultHandler(GenericTextRecognizerFrameHandler.ResultHandler resultHandler)
```
    Registers result handler which will be notified about generic text recognition 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(GenericTextRecognizerFrameHandler.ResultHandler resultHandler)
```
    Unregisters handler.
    
    Parameters:
    
    resultHandler - handler to unregister.
  - clearResultHandlers
```
 final Unit clearResultHandlers()
```
    Unregisters all handlers. If nothing was registered before, nothing happens.