All Implemented Interfaces:
```
public final class MRZScannerConfiguration

                    
```
Class which is used to configure io.scanbot.sdk.ui.view.mrz.MRZScannerActivity Contains settings indicating views Behaviour, Texts and Appearance

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`MRZScannerConfiguration.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private final MrzScannerJsonConfiguration`	`params`
`private final MrzScannerNativeConfiguration`	`nativeParams`
`public final static MRZScannerConfiguration.Companion`	`Companion`

Constructor Summary

Constructors
Constructor	Description
`MRZScannerConfiguration()`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final MrzScannerJsonConfiguration`	`getParams()`
`final MrzScannerNativeConfiguration`	`getNativeParams()`
`final Unit`	`setFlashEnabled(Boolean flashEnabled)`	Controls whether the flash should be initially enabled.
`final Unit`	`setOrientationLockMode(CameraOrientationMode cameraOrientationMode)`	Orientation lock mode of the camera: CameraOrientationMode.PORTRAIT or CameraOrientationMode.LANDSCAPE.
`final Unit`	`setCameraModule(CameraModule cameraModule)`	Set supported camera module: CameraModule.BACK, CameraModule.FRONT or others.
`final Unit`	`setCameraPreviewMode(CameraPreviewMode cameraPreviewMode)`	Preview mode of the camera: CameraPreviewMode.FIT_IN or CameraPreviewMode.FIT_IN.
`final Unit`	`setSuccessBeepEnabled(Boolean successBeepEnabled)`	Controls whether to play a beep sound after a successful detection.
`final Unit`	`setTopBarBackgroundColor(Integer topBarBackgroundColor)`	Background color of the top toolbar.
`final Unit`	`setTopBarButtonsColor(Integer topBarButtonsColor)`	Color of the titles of all buttons in the top toolbar.
`final Unit`	`setCameraOverlayColor(Integer cameraOverlayColor)`	Background color outside of the finder window.
`final Unit`	`setFinderAspectRatio(AspectRatio finderAspectRatio)`	Aspect ratio of the finder window.
`final Unit`	`setFinderLineWidth(Integer finderLineWidth)`	Thickness of the finder window's outline in Px.
`final Unit`	`setFinderLineColor(Integer finderLineColor)`	Color of the finder window's outline.
`final Unit`	`setFinderTextHintColor(Integer finderTextHintColor)`	Color of the text hint under the finder window.
`final Unit`	`setCancelButtonTitle(String cancelButtonTitle)`	Title of the cancel button.
`final Unit`	`setCancelButtonIcon(Integer cancelButtonIcon)`	Icon of the cancel button.
`final Unit`	`setFinderTextHint(String finderTextHint)`	Text hint shown under the finder window.
`final Unit`	`setEnableCameraExplanationText(String enableCameraExplanationText)`	Text that will be displayed when the app is not allowed to use the camera, prompting the user to enable the usage of the camera.
`final Unit`	`setEnableCameraButtonTitle(String enableCameraButtonTitle)`	Title of the button that opens the screen where the user can allow the usage of the camera by the app.
`final Unit`	`setUseButtonsAllCaps(Boolean allCaps)`	Controls whether buttons should use all capitals style.
`final Unit`	`setTouchToFocusEnabled(Boolean enabled)`	Controls whether the touch to focus feature should be enabled.

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

- Constructor Detail
  - MRZScannerConfiguration
```
MRZScannerConfiguration()
```
- Method Detail
  - getParams
```
 final MrzScannerJsonConfiguration getParams()
```
  - getNativeParams
```
 final MrzScannerNativeConfiguration getNativeParams()
```
  - setFlashEnabled
```
 final Unit setFlashEnabled(Boolean flashEnabled)
```
    Controls whether the flash should be initially enabled. The default value is FALSE.
  - setOrientationLockMode
```
 final Unit setOrientationLockMode(CameraOrientationMode cameraOrientationMode)
```
    Orientation lock mode of the camera: CameraOrientationMode.PORTRAIT or CameraOrientationMode.LANDSCAPE. By default the camera orientation is not locked.
  - setCameraModule
```
 final Unit setCameraModule(CameraModule cameraModule)
```
    Set supported camera module: CameraModule.BACK, CameraModule.FRONT or others. Optional. By default is CameraModule.BACK.
  - setCameraPreviewMode
```
 final Unit setCameraPreviewMode(CameraPreviewMode cameraPreviewMode)
```
    Preview mode of the camera: CameraPreviewMode.FIT_IN or CameraPreviewMode.FIT_IN. Optional, default is CameraPreviewMode.FILL_IN.
  - setSuccessBeepEnabled
```
 final Unit setSuccessBeepEnabled(Boolean successBeepEnabled)
```
    Controls whether to play a beep sound after a successful detection. Default value is TRUE.
  - setTopBarBackgroundColor
```
 final Unit setTopBarBackgroundColor(Integer topBarBackgroundColor)
```
    Background color of the top toolbar.
  - setTopBarButtonsColor
```
 final Unit setTopBarButtonsColor(Integer topBarButtonsColor)
```
    Color of the titles of all buttons in the top toolbar.
  - setCameraOverlayColor
```
 final Unit setCameraOverlayColor(Integer cameraOverlayColor)
```
    Background color outside of the finder window.
  - setFinderAspectRatio
```
 final Unit setFinderAspectRatio(AspectRatio finderAspectRatio)
```
    Aspect ratio of the finder window.
  - setFinderLineWidth
```
 final Unit setFinderLineWidth(Integer finderLineWidth)
```
    Thickness of the finder window's outline in Px.
  - setFinderLineColor
```
 final Unit setFinderLineColor(Integer finderLineColor)
```
    Color of the finder window's outline.
  - setFinderTextHintColor
```
 final Unit setFinderTextHintColor(Integer finderTextHintColor)
```
    Color of the text hint under the finder window.
  - setCancelButtonTitle
```
 final Unit setCancelButtonTitle(String cancelButtonTitle)
```
    Title of the cancel button.
  - setCancelButtonIcon
```
 final Unit setCancelButtonIcon(Integer cancelButtonIcon)
```
    Icon of the cancel button.
  - setFinderTextHint
```
 final Unit setFinderTextHint(String finderTextHint)
```
    Text hint shown under the finder window.
  - setEnableCameraExplanationText
```
 final Unit setEnableCameraExplanationText(String enableCameraExplanationText)
```
    Text that will be displayed when the app is not allowed to use the camera, prompting the user to enable the usage of the camera.
  - setEnableCameraButtonTitle
```
 final Unit setEnableCameraButtonTitle(String enableCameraButtonTitle)
```
    Title of the button that opens the screen where the user can allow the usage of the camera by the app.
  - setUseButtonsAllCaps
```
 final Unit setUseButtonsAllCaps(Boolean allCaps)
```
    Controls whether buttons should use all capitals style.
  - setTouchToFocusEnabled
```
 final Unit setTouchToFocusEnabled(Boolean enabled)
```
    Controls whether the touch to focus feature should be enabled. Default is true.

Class MRZScannerConfiguration

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MRZScannerConfiguration

Method Detail

getParams

getNativeParams

setFlashEnabled

setOrientationLockMode

setCameraModule

setCameraPreviewMode

setSuccessBeepEnabled

setTopBarBackgroundColor

setTopBarButtonsColor

setCameraOverlayColor

setFinderAspectRatio

setFinderLineWidth

setFinderLineColor

setFinderTextHintColor

setCancelButtonTitle

setCancelButtonIcon

setFinderTextHint

setEnableCameraExplanationText

setEnableCameraButtonTitle

setUseButtonsAllCaps

setTouchToFocusEnabled