Configuration of the screen for detecting MRZ (Machine-readable zones) of various documents.

Hierarchy (view full)

Constructors

Properties

Configuration of the action bar.

backgroundColor: string

The background color of the MRZ scanner screen.

Default is "?sbColorSurfaceLow"

cameraConfiguration: CameraConfiguration

Configuration of the camera behavior.

cameraPermission: CameraPermissionScreen

Configuration of the dialog for requesting camera permissions.

finderViewUserGuidance: UserGuidanceConfiguration

Configuration of the user guidance below finder view.

Configuration of the introduction screen for the MRZ scanner.

keepScreenOn: boolean

If enabled, the screen will not turn off while the barcode scanner is active. (Android only).

Default is true

Configuration of the all strings for MRZ scanner screen.

mrzExampleOverlay: MrzFinderLayoutPreset

Configuration of the overlay text inside finder.

palette: Palette

Define the screen's base color values from which other colors are derived.

scannerConfiguration: MrzScannerConfiguration

Configuration of the MRZ scanner.

screen: string

The configuration object should be applied for this screen.

Default is "MrzScanner"

sound: Sound

Configuration of the scan confirmation sound.

successOverlay: ScanCompletionOverlay

Configuration of the success overlay.

Configuration of the top bar on the MRZ scanner screen.

topBarOpenIntroScreenButton: IconButton

Configuration of the button in the top bar that opens the introduction screen.

topUserGuidance: UserGuidanceConfiguration

Configuration of the top user guidance.

version: string

Version number of the configuration object.

Default is "1.0"

vibration: Vibration

Configuration of the vibration feedback.

Configuration of the view finder.