MrzScanner

java.lang.Object
- io.scanbot.sdk.mrz.MrzScanner

All Implemented Interfaces:

java.lang.AutoCloseable
```
public class MrzScanner
extends java.lang.Object
implements java.lang.AutoCloseable
```
API for machine readable zone scanning. Required licence feature(s): MrzScanner.

Constructor Summary

Constructors
Constructor Description

MrzScanner(MrzScannerConfiguration configuration)
Constructs MrzScanner with the given params.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`clearResult()`	Clears the accumulated results.
`void`	`close()`	Closes native resources held by the object.
`protected void`	`finalize()`
`MrzScannerResult`	`run(ImageRef image)`	Recognize the MRZ in the given image.

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

- Constructor Detail
  - MrzScanner
```
public MrzScanner(MrzScannerConfiguration configuration)
           throws LicenseException
```
    Constructs MrzScanner with the given params.
    
    Parameters:
    
    configuration - The configuration to use for the scanner.
    
    Throws:
    
    LicenseException - If license requirements for the API are not met
- Method Detail
  - run
```
public MrzScannerResult run(ImageRef image)
                     throws InvalidImageRefException,
                            LicenseException
```
    Recognize the MRZ in the given image.
    
    Parameters:
    
    image - The image to recognize.
    
    Returns:
    
    The recognition result.
    
    Throws:
    
    InvalidImageRefException - If an invalid image reference is used
    
    LicenseException - If license requirements for the API are not met
  - clearResult
```
public void clearResult()
```
    Clears the accumulated results. Should be called after a document has been recognized to the customers satisfaction to prevent a poisoned cache.
  - close
```
public void close()
```
    Closes native resources held by the object.
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
  - finalize
```
protected void finalize()
                 throws java.lang.Throwable
```
    Overrides:
    
    finalize in class java.lang.Object
    
    Throws:
    
    java.lang.Throwable