Customizing the MRZ Scanner

When developing with MRZScanner component (see the User Guide), you can add extra configurations via the MRZScannerConfig class. Before diving into the different ways in which you can customize the MRZ Scanner, let’s first break down the different properties of the MRZScannerConfig class.

MRZScannerConfig Overview

The MRZScannerConfig class is capable of configuring almost all customization options applicable to MRZ scanning use cases with the MRZ Scanner. The MRZ Scanner uses passes an MRZScannerConfig object to the constructor when creating an MRZ Scanner instance. MRZScannerConfig contains the following properties:

1. License - the license key is the only property whose value must be specified when instantiating the MRZ Scanner instance. If the license is undefined, invalid, or expired, the MRZ Scanner cannot proceed with scanning, and instead displays a pop-up error message instructing the user to contact the app administrator to resolve this license issue.

2. DocumentType - specifies the type of document that the MRZ Scanner will recognize. This property accepts values defined in the EnumDocumentType such as EnumDocumentType.All, EnumDocumentType.Id, or EnumDocumentType.Passport. It helps the scanner to optimize its processing based on the expected document type. To learn more about the different document types that are supported, please refer to the Supported Document Types section of the user guide.

3. TemplateFile - a template file is a JSON file or JSON string that contains a series of algorithm parameter settings (called Capture Vision templates) that is usually used for very specific and customized scanning and parsing scenarios. The templateFile points to the location of the JSON file. The MRZ Scanner comes with a default template file, but you may choose to use a custom template to target specialized use cases. We recommend contacting the Dynamsoft Technical Support Team for assistance with template customization.

4. IsBeepEnabled (default value false) - a boolean that determines whether a beep sound is triggered upon a successful MRZ scan. When enabled (true), the scanner will play a sound to provide audible feedback.

5. IsCameraToggleButtonVisible (default value false) - a boolean that specifies whether the camera toggle button is displayed. This button lets users switch between available cameras (e.g., front and rear).

6. IsCloseButtonVisible (default value true) - a boolean to control the visibility of the close button on the scanner’s UI. If true, a close button will be displayed allowing users to exit the MRZ scanning interface.

7. IsGuideFrameVisible (default value true) - serves as a toggle to show or hide the guide frame in the UI during scanning. The guide frame assists users in properly aligning the document for optimal MRZ detection. When set to true, a visual overlay is displayed on the scanning interface.

8. IsTorchButtonVisible (default value true) - determines whether the torch (flashlight) toggle button is visible on the scanning interface. Set to true to allow users to switch the device’s flashlight on or off during MRZ scanning.

9. IsVibrateEnabled (default value false) - controls the scanner’s ability to make the scanning device vibrate upon a successful MRZ scan. When enabled (true), the scanner will vibrate to provide haptic feedback if the device supports it.

Next, we go over the different ways that these properties can be used to customize the scanner with a few examples.

Setting the MRZ Document Type

The MRZ Scanner reads all three MRZ formats, but it can optionally restrict the MRZ format that it reads. For example, you may want to configure MRZ scanner to only read TD1 and passport (TD3) document types, while ignoring TD2 documents. Here is a simple edit to the OnScanMRZ function that we implemented in the User Guide that sets the specific MRZ formats to read using the DocumentType property:

private async void OnScanMRZ(object sender, EventArgs e)
{
    // The string "DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9" here grants a time-limited free trial which requires network connection to work.
    // You can request a 30-day trial license via the Request a Trial License page https://www.dynamsoft.com/customer/license/trialLicense?product=dbr&utm_source=guide&package=maui.
    var config = new MRZScannerConfig("DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9");
    config.DocumentType = EnumDocumentType.Passport; // configuring the scanner to just recognize passports
    var result = await MRZScanner.Start(config);
    if (result.ResultStatus == EnumResultStatus.Finished && result.Data is not null)
    {
        /* Do something with the MRZ Result */
    }
}

Customizing the UI Elements

The MRZ Scanner UI comes with three main elements that you can configure:

• Close button: Stop MRZ scanning and go back to the previous activity.
• Torch button: A clickable button that can turn on/off the torch.
• Guide Frame: A visual overlap to assist users in lining up the MRZ document in the camera frame.

private async void OnScanMRZ(object sender, EventArgs e)
{
    // The string "DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9" here grants a time-limited free trial which requires network connection to work.
    // You can request a 30-day trial license via the Request a Trial License page https://www.dynamsoft.com/customer/license/trialLicense?product=dbr&utm_source=guide&package=maui.
    var config = new MRZScannerConfig("DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9");
    config.IsCloseButtonVisible = false; // hiding the close button
    config.IsTorchButtonVisible = false; // hiding the torch button
    config.IsGuideFrameVisible = false; // hiding the guide frame
    var result = await MRZScanner.Start(config);
    if (result.ResultStatus == EnumResultStatus.Finished && result.Data is not null)
    {
        /* Do something with the MRZ Result */
    }
}

Enabling Audio and Haptic Feedback

The MRZ Scanner library also offers the option to enable audio and haptic feedback upon a successful MRZ scan. Through the IsBeepEnabled and IsVibrateEnabled properties, you can choose to play a sound or make the device vibrate once the MRZ is recognized.

private async void OnScanMRZ(object sender, EventArgs e)
{
    // The string "DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9" here grants a time-limited free trial which requires network connection to work.
    // You can request a 30-day trial license via the Request a Trial License page https://www.dynamsoft.com/customer/license/trialLicense?product=dbr&utm_source=guide&package=maui.
    var config = new MRZScannerConfig("DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9");
    config.IsBeepEnabled = true; // play a beep upon a successful MRZ scan
    config.IsVibrateEnabled = true; // make the phone vibrate upon a successful MRZ scan
    var result = await MRZScanner.Start(config);
    if (result.ResultStatus == EnumResultStatus.Finished && result.Data is not null)
    {
        /* Do something with the MRZ Result */
    }
}