All Implemented Interfaces:: android.os.Parcelable


public final class MrzScannerConfiguration
 implements Parcelable

Configuration for MRZ scanner.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private AccumulatedResultsVerifierConfiguration`	`frameAccumulationConfiguration`
`private Boolean`	`enableDetection`
`private MrzIncompleteResultHandling`	`incompleteResultHandling`
`private Boolean`	`returnCrops`

Constructor Summary

Constructors
Constructor	Description
`MrzScannerConfiguration(Map<String, Object> source)`
`MrzScannerConfiguration(JSONObject json)`
`MrzScannerConfiguration(AccumulatedResultsVerifierConfiguration frameAccumulationConfiguration, Boolean enableDetection, MrzIncompleteResultHandling incompleteResultHandling, Boolean returnCrops)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final AccumulatedResultsVerifierConfiguration`	`getFrameAccumulationConfiguration()`	Configure the frame accumulation process.
`final Unit`	`setFrameAccumulationConfiguration(AccumulatedResultsVerifierConfiguration frameAccumulationConfiguration)`	Configure the frame accumulation process.
`final Boolean`	`getEnableDetection()`	Enable MRZ detection.
`final Unit`	`setEnableDetection(Boolean enableDetection)`	Enable MRZ detection.
`final MrzIncompleteResultHandling`	`getIncompleteResultHandling()`	Defines how to handle incomplete MRZ results (e.g.
`final Unit`	`setIncompleteResultHandling(MrzIncompleteResultHandling incompleteResultHandling)`	Defines how to handle incomplete MRZ results (e.g.
`final Boolean`	`getReturnCrops()`	If true, crops of the detected MRZ and its fields will be returned in the result.
`final Unit`	`setReturnCrops(Boolean returnCrops)`	If true, crops of the detected MRZ and its fields will be returned in the result.
`final JSONObject`	`toJson(ToJsonConfiguration config)`
`final MrzScannerConfiguration`	`clone()`
`final static MrzScannerConfiguration`	`default()`

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

- Constructor Detail
  - MrzScannerConfiguration
```
MrzScannerConfiguration(Map<String, Object> source)
```
  - MrzScannerConfiguration
```
MrzScannerConfiguration(JSONObject json)
```
  - MrzScannerConfiguration
```
MrzScannerConfiguration(AccumulatedResultsVerifierConfiguration frameAccumulationConfiguration, Boolean enableDetection, MrzIncompleteResultHandling incompleteResultHandling, Boolean returnCrops)
```
- Method Detail
  - getFrameAccumulationConfiguration
```
 final AccumulatedResultsVerifierConfiguration getFrameAccumulationConfiguration()
```
    Configure the frame accumulation process.
  - setFrameAccumulationConfiguration
```
 final Unit setFrameAccumulationConfiguration(AccumulatedResultsVerifierConfiguration frameAccumulationConfiguration)
```
    Configure the frame accumulation process.
  - getEnableDetection
```
 final Boolean getEnableDetection()
```
    Enable MRZ detection. If disabled, the scanner skips the detection step and assumes that the input image is a crop of the MRZ area.
    Default is true
  - setEnableDetection
```
 final Unit setEnableDetection(Boolean enableDetection)
```
    Enable MRZ detection. If disabled, the scanner skips the detection step and assumes that the input image is a crop of the MRZ area.
    Default is true
  - getIncompleteResultHandling
```
 final MrzIncompleteResultHandling getIncompleteResultHandling()
```
    Defines how to handle incomplete MRZ results (e.g. caused by failed validation).
    Default is REJECT
  - setIncompleteResultHandling
```
 final Unit setIncompleteResultHandling(MrzIncompleteResultHandling incompleteResultHandling)
```
    Defines how to handle incomplete MRZ results (e.g. caused by failed validation).
    Default is REJECT
  - getReturnCrops
```
 final Boolean getReturnCrops()
```
    If true, crops of the detected MRZ and its fields will be returned in the result.
    Default is false
  - setReturnCrops
```
 final Unit setReturnCrops(Boolean returnCrops)
```
    If true, crops of the detected MRZ and its fields will be returned in the result.
    Default is false
  - toJson
```
 final JSONObject toJson(ToJsonConfiguration config)
```
  - clone
```
 final MrzScannerConfiguration clone()
```
  - default
```
 final static MrzScannerConfiguration default()
```

Class MrzScannerConfiguration

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MrzScannerConfiguration

MrzScannerConfiguration

MrzScannerConfiguration

Method Detail

getFrameAccumulationConfiguration

setFrameAccumulationConfiguration

getEnableDetection

setEnableDetection

getIncompleteResultHandling

setIncompleteResultHandling

getReturnCrops

setReturnCrops

toJson

clone

default