All Implemented Interfaces:

android.os.Parcelable
```
public final class MrzScannerScreenConfiguration
 implements Parcelable
                    
```
Configuration of the screen for detecting MRZ (Machine-readable zones) of various documents.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private final String`	`version`
`private final String`	`screen`
`private MrzScannerScreenTextLocalization`	`localization`
`private Palette`	`palette`
`private ScanbotColor`	`backgroundColor`
`private CameraConfiguration`	`cameraConfiguration`
`private CameraPermissionScreen`	`cameraPermission`
`private UserGuidanceConfiguration`	`topUserGuidance`
`private UserGuidanceConfiguration`	`finderViewUserGuidance`
`private TopBarConfiguration`	`topBar`
`private IconButton`	`topBarOpenIntroScreenButton`
`private MrzScannerIntroScreenConfiguration`	`introScreen`
`private ActionBarConfiguration`	`actionBar`
`private PermanentViewFinderConfiguration`	`viewFinder`
`private MrzScannerConfiguration`	`scannerConfiguration`
`private MrzFinderLayoutPreset`	`mrzExampleOverlay`
`private ScanCompletionOverlay`	`successOverlay`
`private Sound`	`sound`
`private Vibration`	`vibration`
`private Boolean`	`keepScreenOn`

Constructor Summary

Constructors
Constructor	Description
`MrzScannerScreenConfiguration(Map<String, Object> source)`
`MrzScannerScreenConfiguration(JSONObject json)`
MrzScannerScreenConfiguration(String version, String screen, MrzScannerScreenTextLocalization localization, Palette palette, ScanbotColor backgroundColor, CameraConfiguration cameraConfiguration, CameraPermissionScreen cameraPermission, UserGuidanceConfiguration topUserGuidance, UserGuidanceConfiguration finderViewUserGuidance, TopBarConfiguration topBar, IconButton topBarOpenIntroScreenButton, MrzScannerIntroScreenConfiguration introScreen, ActionBarConfiguration actionBar, PermanentViewFinderConfiguration viewFinder, MrzScannerConfiguration scannerConfiguration, MrzFinderLayoutPreset mrzExampleOverlay, ScanCompletionOverlay successOverlay, Sound sound, Vibration vibration, Boolean keepScreenOn)

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`getVersion()`	Version number of the configuration object.
`final String`	`getScreen()`	The configuration object should be applied for this screen.
`final MrzScannerScreenTextLocalization`	`getLocalization()`	Configuration of the all strings for MRZ scanner screen.
`final Unit`	`setLocalization(MrzScannerScreenTextLocalization localization)`	Configuration of the all strings for MRZ scanner screen.
`final Palette`	`getPalette()`	Define the screen's base color values from which other colors are derived.
`final Unit`	`setPalette(Palette palette)`	Define the screen's base color values from which other colors are derived.
`final ScanbotColor`	`getBackgroundColor()`	The background color of the MRZ scanner screen.
`final Unit`	`setBackgroundColor(ScanbotColor backgroundColor)`	The background color of the MRZ scanner screen.
`final CameraConfiguration`	`getCameraConfiguration()`	Configuration of the camera behavior.
`final Unit`	`setCameraConfiguration(CameraConfiguration cameraConfiguration)`	Configuration of the camera behavior.
`final CameraPermissionScreen`	`getCameraPermission()`	Configuration of the dialog for requesting camera permissions.
`final Unit`	`setCameraPermission(CameraPermissionScreen cameraPermission)`	Configuration of the dialog for requesting camera permissions.
`final UserGuidanceConfiguration`	`getTopUserGuidance()`	Configuration of the top user guidance.
`final Unit`	`setTopUserGuidance(UserGuidanceConfiguration topUserGuidance)`	Configuration of the top user guidance.
`final UserGuidanceConfiguration`	`getFinderViewUserGuidance()`	Configuration of the user guidance below finder view.
`final Unit`	`setFinderViewUserGuidance(UserGuidanceConfiguration finderViewUserGuidance)`	Configuration of the user guidance below finder view.
`final TopBarConfiguration`	`getTopBar()`	Configuration of the top bar on the MRZ scanner screen.
`final Unit`	`setTopBar(TopBarConfiguration topBar)`	Configuration of the top bar on the MRZ scanner screen.
`final IconButton`	`getTopBarOpenIntroScreenButton()`	Configuration of the button in the top bar that opens the introduction screen.
`final Unit`	`setTopBarOpenIntroScreenButton(IconButton topBarOpenIntroScreenButton)`	Configuration of the button in the top bar that opens the introduction screen.
`final MrzScannerIntroScreenConfiguration`	`getIntroScreen()`	Configuration of the introduction screen for the MRZ scanner.
`final Unit`	`setIntroScreen(MrzScannerIntroScreenConfiguration introScreen)`	Configuration of the introduction screen for the MRZ scanner.
`final ActionBarConfiguration`	`getActionBar()`	Configuration of the action bar.
`final Unit`	`setActionBar(ActionBarConfiguration actionBar)`	Configuration of the action bar.
`final PermanentViewFinderConfiguration`	`getViewFinder()`	Configuration of the view finder.
`final Unit`	`setViewFinder(PermanentViewFinderConfiguration viewFinder)`	Configuration of the view finder.
`final MrzScannerConfiguration`	`getScannerConfiguration()`	Configuration of the MRZ scanner.
`final Unit`	`setScannerConfiguration(MrzScannerConfiguration scannerConfiguration)`	Configuration of the MRZ scanner.
`final MrzFinderLayoutPreset`	`getMrzExampleOverlay()`	Configuration of the overlay text inside finder.
`final Unit`	`setMrzExampleOverlay(MrzFinderLayoutPreset mrzExampleOverlay)`	Configuration of the overlay text inside finder.
`final ScanCompletionOverlay`	`getSuccessOverlay()`	Configuration of the success overlay.
`final Unit`	`setSuccessOverlay(ScanCompletionOverlay successOverlay)`	Configuration of the success overlay.
`final Sound`	`getSound()`	Configuration of the scan confirmation sound.
`final Unit`	`setSound(Sound sound)`	Configuration of the scan confirmation sound.
`final Vibration`	`getVibration()`	Configuration of the vibration feedback.
`final Unit`	`setVibration(Vibration vibration)`	Configuration of the vibration feedback.
`final Boolean`	`getKeepScreenOn()`	If enabled, the screen will not turn off while the barcode scanner is active.
`final Unit`	`setKeepScreenOn(Boolean keepScreenOn)`	If enabled, the screen will not turn off while the barcode scanner is active.
`final JSONObject`	`toJson(ToJsonConfiguration config)`
`final MrzScannerScreenConfiguration`	`clone()`
`final static MrzScannerScreenConfiguration`	`default()`

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

Constructor Detail

MrzScannerScreenConfiguration

MrzScannerScreenConfiguration(Map<String, Object> source)

MrzScannerScreenConfiguration

MrzScannerScreenConfiguration(JSONObject json)

MrzScannerScreenConfiguration

MrzScannerScreenConfiguration(String version, String screen, MrzScannerScreenTextLocalization localization, Palette palette, ScanbotColor backgroundColor, CameraConfiguration cameraConfiguration, CameraPermissionScreen cameraPermission, UserGuidanceConfiguration topUserGuidance, UserGuidanceConfiguration finderViewUserGuidance, TopBarConfiguration topBar, IconButton topBarOpenIntroScreenButton, MrzScannerIntroScreenConfiguration introScreen, ActionBarConfiguration actionBar, PermanentViewFinderConfiguration viewFinder, MrzScannerConfiguration scannerConfiguration, MrzFinderLayoutPreset mrzExampleOverlay, ScanCompletionOverlay successOverlay, Sound sound, Vibration vibration, Boolean keepScreenOn)

Method Detail
- getVersion
```
 final String getVersion()
```
  Version number of the configuration object.
  Default is "1.0"
- getScreen
```
 final String getScreen()
```
  The configuration object should be applied for this screen.
  Default is "MrzScanner"
- getLocalization
```
 final MrzScannerScreenTextLocalization getLocalization()
```
  Configuration of the all strings for MRZ scanner screen.
- setLocalization
```
 final Unit setLocalization(MrzScannerScreenTextLocalization localization)
```
  Configuration of the all strings for MRZ scanner screen.
- getPalette
```
 final Palette getPalette()
```
  Define the screen's base color values from which other colors are derived.
- setPalette
```
 final Unit setPalette(Palette palette)
```
  Define the screen's base color values from which other colors are derived.
- getBackgroundColor
```
 final ScanbotColor getBackgroundColor()
```
  The background color of the MRZ scanner screen.
  Default is "?sbColorSurfaceLow"
- setBackgroundColor
```
 final Unit setBackgroundColor(ScanbotColor backgroundColor)
```
  The background color of the MRZ scanner screen.
  Default is "?sbColorSurfaceLow"
- getCameraConfiguration
```
 final CameraConfiguration getCameraConfiguration()
```
  Configuration of the camera behavior.
- setCameraConfiguration
```
 final Unit setCameraConfiguration(CameraConfiguration cameraConfiguration)
```
  Configuration of the camera behavior.
- getCameraPermission
```
 final CameraPermissionScreen getCameraPermission()
```
  Configuration of the dialog for requesting camera permissions.
- setCameraPermission
```
 final Unit setCameraPermission(CameraPermissionScreen cameraPermission)
```
  Configuration of the dialog for requesting camera permissions.
- getTopUserGuidance
```
 final UserGuidanceConfiguration getTopUserGuidance()
```
  Configuration of the top user guidance.
- setTopUserGuidance
```
 final Unit setTopUserGuidance(UserGuidanceConfiguration topUserGuidance)
```
  Configuration of the top user guidance.
- getFinderViewUserGuidance
```
 final UserGuidanceConfiguration getFinderViewUserGuidance()
```
  Configuration of the user guidance below finder view.
- setFinderViewUserGuidance
```
 final Unit setFinderViewUserGuidance(UserGuidanceConfiguration finderViewUserGuidance)
```
  Configuration of the user guidance below finder view.
- getTopBar
```
 final TopBarConfiguration getTopBar()
```
  Configuration of the top bar on the MRZ scanner screen.
- setTopBar
```
 final Unit setTopBar(TopBarConfiguration topBar)
```
  Configuration of the top bar on the MRZ scanner screen.
- getTopBarOpenIntroScreenButton
```
 final IconButton getTopBarOpenIntroScreenButton()
```
  Configuration of the button in the top bar that opens the introduction screen.
- setTopBarOpenIntroScreenButton
```
 final Unit setTopBarOpenIntroScreenButton(IconButton topBarOpenIntroScreenButton)
```
  Configuration of the button in the top bar that opens the introduction screen.
- getIntroScreen
```
 final MrzScannerIntroScreenConfiguration getIntroScreen()
```
  Configuration of the introduction screen for the MRZ scanner.
- setIntroScreen
```
 final Unit setIntroScreen(MrzScannerIntroScreenConfiguration introScreen)
```
  Configuration of the introduction screen for the MRZ scanner.
- getActionBar
```
 final ActionBarConfiguration getActionBar()
```
  Configuration of the action bar.
- setActionBar
```
 final Unit setActionBar(ActionBarConfiguration actionBar)
```
  Configuration of the action bar.
- getViewFinder
```
 final PermanentViewFinderConfiguration getViewFinder()
```
  Configuration of the view finder.
- setViewFinder
```
 final Unit setViewFinder(PermanentViewFinderConfiguration viewFinder)
```
  Configuration of the view finder.
- getScannerConfiguration
```
 final MrzScannerConfiguration getScannerConfiguration()
```
  Configuration of the MRZ scanner.
- setScannerConfiguration
```
 final Unit setScannerConfiguration(MrzScannerConfiguration scannerConfiguration)
```
  Configuration of the MRZ scanner.
- getMrzExampleOverlay
```
 final MrzFinderLayoutPreset getMrzExampleOverlay()
```
  Configuration of the overlay text inside finder.
- setMrzExampleOverlay
```
 final Unit setMrzExampleOverlay(MrzFinderLayoutPreset mrzExampleOverlay)
```
  Configuration of the overlay text inside finder.
- getSuccessOverlay
```
 final ScanCompletionOverlay getSuccessOverlay()
```
  Configuration of the success overlay.
- setSuccessOverlay
```
 final Unit setSuccessOverlay(ScanCompletionOverlay successOverlay)
```
  Configuration of the success overlay.
- getSound
```
 final Sound getSound()
```
  Configuration of the scan confirmation sound.
- setSound
```
 final Unit setSound(Sound sound)
```
  Configuration of the scan confirmation sound.
- getVibration
```
 final Vibration getVibration()
```
  Configuration of the vibration feedback.
- setVibration
```
 final Unit setVibration(Vibration vibration)
```
  Configuration of the vibration feedback.
- getKeepScreenOn
```
 final Boolean getKeepScreenOn()
```
  If enabled, the screen will not turn off while the barcode scanner is active. (Android only).
  Default is true
- setKeepScreenOn
```
 final Unit setKeepScreenOn(Boolean keepScreenOn)
```
  If enabled, the screen will not turn off while the barcode scanner is active. (Android only).
  Default is true
- toJson
```
 final JSONObject toJson(ToJsonConfiguration config)
```
- clone
```
 final MrzScannerScreenConfiguration clone()
```
- default
```
 final static MrzScannerScreenConfiguration default()
```

Class MrzScannerScreenConfiguration

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MrzScannerScreenConfiguration

MrzScannerScreenConfiguration

MrzScannerScreenConfiguration

Method Detail

getVersion

getScreen

getLocalization

setLocalization

getPalette

setPalette

getBackgroundColor

setBackgroundColor

getCameraConfiguration

setCameraConfiguration

getCameraPermission

setCameraPermission

getTopUserGuidance

setTopUserGuidance

getFinderViewUserGuidance

setFinderViewUserGuidance

getTopBar

setTopBar

getTopBarOpenIntroScreenButton

setTopBarOpenIntroScreenButton

getIntroScreen

setIntroScreen

getActionBar

setActionBar

getViewFinder

setViewFinder

getScannerConfiguration

setScannerConfiguration

getMrzExampleOverlay

setMrzExampleOverlay

getSuccessOverlay

setSuccessOverlay

getSound

setSound

getVibration

setVibration

getKeepScreenOn

setKeepScreenOn

toJson

clone

default