IdCardScannerFrameHandler 1.84.1.165-SNAPSHOT API

All Implemented Interfaces:

io.scanbot.sdk.camera.FrameHandler
```
public final class IdCardScannerFrameHandler
 implements FrameHandler
                    
```
Performs ID card data detection on camera preview frames. Outputs results via IdCardScannerFrameHandler.ResultHandler.
Preview frame considered intercepted if at least one IdCardScannerFrameHandler.ResultHandler returns true from IdCardScannerFrameHandler.ResultHandler.handle

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public interface`	`IdCardScannerFrameHandler.ResultHandler`	Continuously notified about ID card scanner results.
`public abstract class`	`IdCardScannerFrameHandler.IdCardScannerResultHandler`	Successor-class needed for cross-platform implementation
`public class`	`IdCardScannerFrameHandler.Companion`

Field Summary

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

Constructor Summary

Constructors
Constructor	Description
`IdCardScannerFrameHandler(IdCardScanner idCardScanner, Boolean shouldRecognize)`

Method Summary

Modifier and Type	Method	Description
`final Boolean`	`getIsEnabled()`	Parameter determines if ID card detection is enabled.
`final Unit`	`setIsEnabled(Boolean isEnabled)`	Parameter determines if ID card detection is enabled.
`Boolean`	`handleFrame(FrameHandler.Frame previewFrame)`
`final Unit`	`addResultHandler(IdCardScannerFrameHandler.ResultHandler resultHandler)`	Registers result handler which will be notified about ID card detection results.
`final Unit`	`removeResultHandler(IdCardScannerFrameHandler.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
  - IdCardScannerFrameHandler
```
IdCardScannerFrameHandler(IdCardScanner idCardScanner, Boolean shouldRecognize)
```
    Parameters:
    
    shouldRecognize - whether to recognize field and their data on ID card.
- Method Detail
  - getIsEnabled
```
 final Boolean getIsEnabled()
```
    Parameter determines if ID card detection is enabled. In case of false value incoming frames are skipped.
    Default is true
  - setIsEnabled
```
 final Unit setIsEnabled(Boolean isEnabled)
```
    Parameter determines if ID card detection 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(IdCardScannerFrameHandler.ResultHandler resultHandler)
```
    Registers result handler which will be notified about ID card detection 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(IdCardScannerFrameHandler.ResultHandler resultHandler)
```
    Unregisters handler.
    
    Parameters:
    
    resultHandler - handler to unregister.
  - clearResultHandlers
```
 final Unit clearResultHandlers()
```
    Unregisters all handlers. If nothing was registered before, nothing happens.