Package-level declarations
Types
Link copied to clipboard
Source of the text for the MRZ finder example overlay.
Link copied to clipboard
A custom image for the introduction screen.
Link copied to clipboard
No image for the introduction screen.
Link copied to clipboard
No image for the introduction screen.
Link copied to clipboard
Android native configuration for the scanner.
Link copied to clipboard
Determines the image for the introduction screen.
Link copied to clipboard
data class MrzScannerIntroScreenConfiguration(var image: MrzScannerIntroImage = MrzIntroDefaultImage( ), var backgroundColor: ScanbotColor = ScanbotColor("?sbColorSurface", isArgb = false), var dividerColor: ScanbotColor = ScanbotColor("?sbColorOutline", isArgb = false), var handlerColor: ScanbotColor = ScanbotColor("?sbColorOutline", isArgb = false), var showAutomatically: Boolean = false, var title: StyledText = StyledText( text = "?introScreenTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), var explanation: StyledText = StyledText( text = "?introScreenText", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), var doneButton: ButtonConfiguration = ButtonConfiguration( text = "?introScreenDoneButton", accessibilityDescription = "?accessibilityDescriptionIntroScreenDoneButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("?sbColorPrimary", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) )) : Parcelable
Configuration of the introduction screen for the MRZ scanner.
Link copied to clipboard
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.
Link copied to clipboard
data class MrzScannerScreenTextLocalization(var topBarTitle: String = "MRZ Scanner", var topBarCancelButton: String = "Cancel", var topUserGuidance: String = "Scan your Identity Document", var finderViewUserGuidance: String = "Scan the MRZ", var introScreenTitle: String = "How to scan an MRZ", var introScreenDoneButton: String = "Start Scanning", var introScreenText: String = "The Machine Readable Zone (MRZ) is a special code on your ID document (such as a passport or ID card) that contains your personal information in a machine-readable format.", var completionOverlaySuccessMessage: String = "Scanned successfully", var accessibilityDescriptionOpenIntroScreenButton: String = "Open introduction screen.", var accessibilityDescriptionIntroScreenDoneButton: String = "Start scanning", var accessibilityDescriptionCancelButton: String = "Cancel", var accessibilityDescriptionFlashButton: String = "Toggle flash", var accessibilityDescriptionZoomButton: String = "Toggle camera zoom", var accessibilityDescriptionFlipCameraButton: String = "Flip camera", var cameraPermissionEnableCameraTitle: String = "Camera permission denied!", var cameraPermissionEnableCameraExplanation: String = "Please allow the usage of the camera to start the scanning process.", var cameraPermissionEnableCameraButton: String = "Grant permission", var cameraPermissionCloseButton: String = "Close", var accessibilityDescriptionCameraPermissionEnableCameraButton: String = "Tap to grant camera permission", var accessibilityDescriptionCameraPermissionCloseButton: String = "Close screen without granting permission") : Parcelable
Configuration of the all strings for MRZ scanner screen.
Link copied to clipboard
data class MrzScannerUiResult(val rawMRZ: String, val mrzDocument: GenericDocument?) : AutoCloseable, Parcelable
Configuration of the MRZ RTU UI result.
Link copied to clipboard
No layout preset.
Link copied to clipboard
data class ThreeLineMrzFinderLayoutPreset(var mrzTextLine1: String = "I<USA2342353464<<<<<<<<<<<<<<<", var mrzTextLine2: String = "9602300M2904076USA<<<<<<<<<<<2", var mrzTextLine3: String = "SMITH<<JACK<<<<<<<<<<<<<<<<<<<", val adjustedFinderAspectRatio: Double = 4.3125) : MrzFinderLayoutPreset, Parcelable
A ready-to-use preset 3-line text to be displayed.
Link copied to clipboard
data class TwoLineMrzFinderLayoutPreset(var mrzTextLine1: String = "I<USASMITH<<JACK<<<<<<<<<<<<<<<<<<<<", var mrzTextLine2: String = "2342353464USA9602300M2904076<<<<<<<2", val adjustedFinderAspectRatio: Double = 5.390625) : MrzFinderLayoutPreset, Parcelable
A ready-to-use preset 2-line text to be displayed.