MRZScannerConfig

MRZScannerConfig is responsible for the configuration of the MRZ Scanner, from assigning the MRZ Scanner license to configuring the supported document types, along with other customizations.

If you are wondering about the different ways you can customize the MRZ Scanner, please refer to the MRZ Scanner Customization Guide.

Definition

Assembly: dynamsoft_mrz_scanner_bundle_flutter

final class MRZScannerConfig

Properties

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.

String license;

templateFile

Specifies the template configuration with a file path or a JSON string that defines the various MRZ Scanner parameters. These specialized templates are usually used for very specific and customized scanning scenarios.

String? templateFile;

Remarks

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.

documentType

Specifies the type of document that the MRZ Scanner will recognize, represented as a EnumDocumentType. This property accepts values defined in the EnumDocumentType such as EnumDocumentType.all (TD1/2/3), EnumDocumentType.id (TD1/2), or EnumDocumentType.passport (TD3).

EnumDocumentType? documentType;

Remarks

If you would like to learn more about the supported document types, please refer to the Supported Document Types section of the user guide.

isTorchButtonVisible

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.

bool? isTorchButtonVisible;

isBeepEnabled

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.

bool? isBeepEnabled;

isCloseButtonVisible

Controls 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.

bool? isCloseButtonVisible;

isGuideFrameVisible

Determines the visibility status of the guide frame on the display. If set to true, a visual overlay will be displayed in the centre of the camera view to allow users to easily line up the MRZ document

bool IsGuideFrameVisible { get; set; };

isCameraToggleButtonVisible

Specifies whether the camera toggle button is displayed. This button lets users switch between available cameras (e.g., front and rear).

bool? isCameraToggleButtonVisible;

isVibrateEnabled

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.

bool? isVibrateEnabled;