API Reference Index

The MRZ Scanner library comes with a number of classes and interfaces which we will dive into in the API documentation. There are three main classes: MRZScanner, MRZScannerView, MRZResultView, and MRZResult. In terms of interfaces, the main ones are: MRZScannerConfig, MRZScannerViewConfig, and MRZResultViewConfig.

Please read through the full API reference, but you can find a summarized list of the classes, interfaces, and enums below.

Classes

1. MRZScanner - The main class of the MRZ Scanner, which is used to create and configure the MRZ Scanner instance.

2. MRZScannerView - Represents the main view of the MRZ Scanner where the scanning operation occurs.

3. MRZResultView - Displays the parsed MRZ result in human readable fields, along with a cropped image of the MRZ document.

Interfaces

1. MRZScannerConfig - The main configuration class of the MRZScanner. It is used to assign the supported MRTD formats of your application as well as the configurations of the MRZScannerView and the MRZResultView.

2. MRZScannerViewConfig - Configures the different UI elements of the MRZScannerView.

3. MRZResultViewConfig - Configures the different UI elements of the MRZResultView.

4. MRZResultViewToolbarButtonsConfig - Configures the toolbar buttons of the MRZResultView.

5. MRZResult - Represents a typical MRZ result along with all of the parsed fields that come with it.

6. MRZData - Represents the parsed MRZ data that is part of the MRZResult.

7. MRZDate - Represents a date in the MRZ fields - which is usually used for date of birth and the date of expiry.

Enumerations

All of the enumerations can be found here. Here is a summarized list of the available enumerations.

1. EnumMRZDocumentType - An enumeration to represent the different types of MRTD formats that the MRZScanner supports.

2. EnumResultStatus - An enumeration to represent the status of a MRZ result.

3. EnumMRZData - An enumeration to represent the different fields of the MRZData interface.