Android Scanbot SDK API reference/io.scanbot.sdk.ui_v2.mrz.configuration/MrzScannerScreenConfiguration

MrzScannerScreenConfiguration

data class MrzScannerScreenConfiguration(val version: String = "1.0", val screen: String = "MrzScanner", var localization: MrzScannerScreenTextLocalization = MrzScannerScreenTextLocalization( ), var palette: Palette = Palette( ), var backgroundColor: ScanbotColor = ScanbotColor("?sbColorSurfaceLow", isArgb = false), var cameraConfiguration: CameraConfiguration = CameraConfiguration( orientationLockMode = OrientationLockMode.PORTRAIT ), var cameraPermission: CameraPermissionScreen = CameraPermissionScreen( statusBarMode = StatusBarMode.DARK, background = ScanbotColor("?sbColorSurface", isArgb = false), iconBackground = ScanbotColor("?sbColorOutline", isArgb = false), icon = IconStyle( visible = true, color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), enableCameraButton = ButtonConfiguration( visible = true, text = "?cameraPermissionEnableCameraButton", accessibilityDescription = "?accessibilityDescriptionCameraPermissionEnableCameraButton", background = BackgroundStyle( strokeColor = ScanbotColor("?sbColorPrimary", isArgb = false), fillColor = ScanbotColor("?sbColorPrimary", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( iconVisible = false, color = ScanbotColor("?sbColorOnPrimary", isArgb = false), useShadow = false ) ), closeButton = ButtonConfiguration( visible = true, text = "?cameraPermissionCloseButton", accessibilityDescription = "?accessibilityDescriptionCameraPermissionCloseButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( iconVisible = false, color = ScanbotColor("?sbColorPrimary", isArgb = false), useShadow = false ) ), enableCameraTitle = StyledText( text = "?cameraPermissionEnableCameraTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), enableCameraExplanation = StyledText( text = "?cameraPermissionEnableCameraExplanation", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false) ) ), var topUserGuidance: UserGuidanceConfiguration = UserGuidanceConfiguration( title = StyledText( text = "?topUserGuidance" ) ), var finderViewUserGuidance: UserGuidanceConfiguration = UserGuidanceConfiguration( title = StyledText( text = "?finderViewUserGuidance" ) ), var topBar: TopBarConfiguration = TopBarConfiguration( title = StyledText( visible = true, text = "?topBarTitle" ), cancelButton = ButtonConfiguration( text = "?topBarCancelButton", accessibilityDescription = "?accessibilityDescriptionCancelButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) ) ), var topBarOpenIntroScreenButton: IconButton = IconButton( color = ScanbotColor("?sbColorOnPrimary", isArgb = false), accessibilityDescription = "?accessibilityDescriptionOpenIntroScreenButton" ), var introScreen: MrzScannerIntroScreenConfiguration = MrzScannerIntroScreenConfiguration( ), var actionBar: ActionBarConfiguration = ActionBarConfiguration( flipCameraButton = RoundButton( visible = false, accessibilityDescription = "?accessibilityDescriptionFlipCameraButton", backgroundColor = ScanbotColor("?sbColorSurfaceHigh", isArgb = false), foregroundColor = ScanbotColor("?sbColorOnPrimary", isArgb = false), activeBackgroundColor = ScanbotColor("?sbColorWarning", isArgb = false), activeForegroundColor = ScanbotColor("#1C1B1F", isArgb = false) ) ), var viewFinder: PermanentViewFinderConfiguration = PermanentViewFinderConfiguration( style = FinderCorneredStyle( strokeColor = ScanbotColor("?sbColorSurface", isArgb = false), strokeWidth = 2.0 ), aspectRatio = AspectRatio( width = -1.0, height = -1.0 ), minimumInsets = EdgeInsets( top = 24.0, left = 24.0, bottom = 24.0, right = 24.0 ) ), var scannerConfiguration: MrzScannerConfiguration = MrzScannerConfiguration( ), var mrzExampleOverlay: MrzFinderLayoutPreset = TwoLineMrzFinderLayoutPreset( ), var successOverlay: ScanCompletionOverlay = ScanCompletionOverlay( ), var sound: Sound = Sound( ), var vibration: Vibration = Vibration( ), var keepScreenOn: Boolean = true) : Parcelable

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

Constructors

Link copied to clipboard
constructor(source: Map<String, Any?>)
constructor(json: JSONObject)
constructor(version: String = "1.0", screen: String = "MrzScanner", localization: MrzScannerScreenTextLocalization = MrzScannerScreenTextLocalization( ), palette: Palette = Palette( ), backgroundColor: ScanbotColor = ScanbotColor("?sbColorSurfaceLow", isArgb = false), cameraConfiguration: CameraConfiguration = CameraConfiguration( orientationLockMode = OrientationLockMode.PORTRAIT ), cameraPermission: CameraPermissionScreen = CameraPermissionScreen( statusBarMode = StatusBarMode.DARK, background = ScanbotColor("?sbColorSurface", isArgb = false), iconBackground = ScanbotColor("?sbColorOutline", isArgb = false), icon = IconStyle( visible = true, color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), enableCameraButton = ButtonConfiguration( visible = true, text = "?cameraPermissionEnableCameraButton", accessibilityDescription = "?accessibilityDescriptionCameraPermissionEnableCameraButton", background = BackgroundStyle( strokeColor = ScanbotColor("?sbColorPrimary", isArgb = false), fillColor = ScanbotColor("?sbColorPrimary", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( iconVisible = false, color = ScanbotColor("?sbColorOnPrimary", isArgb = false), useShadow = false ) ), closeButton = ButtonConfiguration( visible = true, text = "?cameraPermissionCloseButton", accessibilityDescription = "?accessibilityDescriptionCameraPermissionCloseButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( iconVisible = false, color = ScanbotColor("?sbColorPrimary", isArgb = false), useShadow = false ) ), enableCameraTitle = StyledText( text = "?cameraPermissionEnableCameraTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), enableCameraExplanation = StyledText( text = "?cameraPermissionEnableCameraExplanation", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false) ) ), topUserGuidance: UserGuidanceConfiguration = UserGuidanceConfiguration( title = StyledText( text = "?topUserGuidance" ) ), finderViewUserGuidance: UserGuidanceConfiguration = UserGuidanceConfiguration( title = StyledText( text = "?finderViewUserGuidance" ) ), topBar: TopBarConfiguration = TopBarConfiguration( title = StyledText( visible = true, text = "?topBarTitle" ), cancelButton = ButtonConfiguration( text = "?topBarCancelButton", accessibilityDescription = "?accessibilityDescriptionCancelButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) ) ), topBarOpenIntroScreenButton: IconButton = IconButton( color = ScanbotColor("?sbColorOnPrimary", isArgb = false), accessibilityDescription = "?accessibilityDescriptionOpenIntroScreenButton" ), introScreen: MrzScannerIntroScreenConfiguration = MrzScannerIntroScreenConfiguration( ), actionBar: ActionBarConfiguration = ActionBarConfiguration( flipCameraButton = RoundButton( visible = false, accessibilityDescription = "?accessibilityDescriptionFlipCameraButton", backgroundColor = ScanbotColor("?sbColorSurfaceHigh", isArgb = false), foregroundColor = ScanbotColor("?sbColorOnPrimary", isArgb = false), activeBackgroundColor = ScanbotColor("?sbColorWarning", isArgb = false), activeForegroundColor = ScanbotColor("#1C1B1F", isArgb = false) ) ), viewFinder: PermanentViewFinderConfiguration = PermanentViewFinderConfiguration( style = FinderCorneredStyle( strokeColor = ScanbotColor("?sbColorSurface", isArgb = false), strokeWidth = 2.0 ), aspectRatio = AspectRatio( width = -1.0, height = -1.0 ), minimumInsets = EdgeInsets( top = 24.0, left = 24.0, bottom = 24.0, right = 24.0 ) ), scannerConfiguration: MrzScannerConfiguration = MrzScannerConfiguration( ), mrzExampleOverlay: MrzFinderLayoutPreset = TwoLineMrzFinderLayoutPreset( ), successOverlay: ScanCompletionOverlay = ScanCompletionOverlay( ), sound: Sound = Sound( ), vibration: Vibration = Vibration( ), keepScreenOn: Boolean = true)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
var actionBar: ActionBarConfiguration

Configuration of the action bar.

Link copied to clipboard
var backgroundColor: ScanbotColor

The background color of the MRZ scanner screen.

Link copied to clipboard
var cameraConfiguration: CameraConfiguration

Configuration of the camera behavior.

Link copied to clipboard
var cameraPermission: CameraPermissionScreen

Configuration of the dialog for requesting camera permissions.

Link copied to clipboard
var finderViewUserGuidance: UserGuidanceConfiguration

Configuration of the user guidance below finder view.

Link copied to clipboard
var introScreen: MrzScannerIntroScreenConfiguration

Configuration of the introduction screen for the MRZ scanner.

Link copied to clipboard
var keepScreenOn: Boolean

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

Link copied to clipboard
var localization: MrzScannerScreenTextLocalization

Configuration of the all strings for MRZ scanner screen.

Link copied to clipboard
var mrzExampleOverlay: MrzFinderLayoutPreset

Configuration of the overlay text inside finder.

Link copied to clipboard
var palette: Palette

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

Link copied to clipboard
var scannerConfiguration: MrzScannerConfiguration

Configuration of the MRZ scanner.

Link copied to clipboard
val screen: String

The configuration object should be applied for this screen.

Link copied to clipboard
var sound: Sound

Configuration of the scan confirmation sound.

Link copied to clipboard
var successOverlay: ScanCompletionOverlay

Configuration of the success overlay.

Link copied to clipboard
var topBar: TopBarConfiguration

Configuration of the top bar on the MRZ scanner screen.

Link copied to clipboard
var topBarOpenIntroScreenButton: IconButton

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

Link copied to clipboard
var topUserGuidance: UserGuidanceConfiguration

Configuration of the top user guidance.

Link copied to clipboard
val version: String

Version number of the configuration object.

Link copied to clipboard
var vibration: Vibration

Configuration of the vibration feedback.

Link copied to clipboard
var viewFinder: PermanentViewFinderConfiguration

Configuration of the view finder.

Functions

Link copied to clipboard
Link copied to clipboard
fun toJson(config: ToJsonConfiguration = ToJsonConfiguration.default()): JSONObject