MRZScannerFrameHandler 1.84.1.165-SNAPSHOT API

All Implemented Interfaces:

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

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public interface`	`MRZScannerFrameHandler.ResultHandler`	Continuously notified about MRZ data detection results.
`public abstract class`	`MRZScannerFrameHandler.MrzScannerResultHandler`	Successor-class needed for cross-platform implementation
`public class`	`MRZScannerFrameHandler.Companion`

Field Summary

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

Constructor Summary

Constructors
Constructor	Description
`MRZScannerFrameHandler(Context context, MRZScanner mrzScanner)`
`MRZScannerFrameHandler(MRZScanner mrzScanner)`

Method Summary

Modifier and Type	Method	Description
`final Boolean`	`getIsEnabled()`
`final Unit`	`setIsEnabled(Boolean isEnabled)`
`Boolean`	`handleFrame(FrameHandler.Frame previewFrame)`
`final Unit`	`addResultHandler(MRZScannerFrameHandler.ResultHandler handler)`	Registers result handler which will be notified about MRZ data detection results.
`final Unit`	`removeResultHandler(MRZScannerFrameHandler.ResultHandler handler)`	Unregisters handler.

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

- Constructor Detail
  - MRZScannerFrameHandler
```
MRZScannerFrameHandler(Context context, MRZScanner mrzScanner)
```
  - MRZScannerFrameHandler
```
MRZScannerFrameHandler(MRZScanner mrzScanner)
```
- Method Detail
  - getIsEnabled
```
 final Boolean getIsEnabled()
```
  - setIsEnabled
```
 final Unit setIsEnabled(Boolean isEnabled)
```
    Parameters:
    
    isEnabled - true to enable MRZ data detection.
  - handleFrame
```
@Synchronized() Boolean handleFrame(FrameHandler.Frame previewFrame)
```
  - addResultHandler
```
 final Unit addResultHandler(MRZScannerFrameHandler.ResultHandler handler)
```
    Registers result handler which will be notified about MRZ 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(MRZScannerFrameHandler.ResultHandler handler)
```
    Unregisters handler.
    
    Parameters:
    
    handler - handler to unregister.