Android Scanbot SDK API reference/io.scanbot.sdk.ui_v2.document.configuration/CameraScreenConfiguration

CameraScreenConfiguration

data class CameraScreenConfiguration(var acknowledgement: AcknowledgementScreenConfiguration = AcknowledgementScreenConfiguration( ), var introduction: IntroductionScreenConfiguration = IntroductionScreenConfiguration( ), var scanAssistanceOverlay: ScanAssistanceOverlay = ScanAssistanceOverlay( ), 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 topBarTitle: StyledText = StyledText( text = "?cameraTopBarTitle", color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), var topBarIntroButton: IconButton = IconButton( color = ScanbotColor("?sbColorOnPrimary", isArgb = false), accessibilityDescription = "?accessibilityDescriptionCameraTopBarIntroButton" ), var topBarBackButton: ButtonConfiguration = ButtonConfiguration( visible = true, text = "?cameraTopBarCancelButtonTitle", accessibilityDescription = "?accessibilityDescriptionCameraTopBarCancelButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( iconVisible = true, color = ScanbotColor("?sbColorOnPrimary", isArgb = false), useShadow = false ) ), var topUserGuidance: UserGuidanceConfiguration = UserGuidanceConfiguration( title = StyledText( text = "?cameraTopGuidance", color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) ), var userGuidance: DocumentScannerUserGuidance = DocumentScannerUserGuidance( ), var backgroundColor: ScanbotColor = ScanbotColor("#000000FF", isArgb = false), var autoRotateImages: Boolean = true, var openReviewAfterEachScan: Boolean = false, var cameraConfiguration: DocumentScannerCameraConfiguration = DocumentScannerCameraConfiguration( ), var scannerParameters: DocumentScannerParameters = DocumentScannerParameters( ), var polygon: DocumentPolygonConfiguration = DocumentPolygonConfiguration( ), var bottomBar: CameraBottomBar = CameraBottomBar( ), var viewFinder: ViewFinderConfiguration = ViewFinderConfiguration( aspectRatio = AspectRatio( width = 21.0, height = 29.0 ), visible = false ), var captureFeedback: CaptureFeedback = CaptureFeedback( ), var vibration: Vibration = Vibration( enabled = true ), var timeouts: Timeouts = Timeouts( autoCancelTimeout = 0, initialScanDelay = 0 ), var limitReachedAlertDialog: ScanbotAlertDialog = ScanbotAlertDialog( title = StyledText( text = "?cameraLimitReachedAlertTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), subtitle = StyledText( text = "?cameraLimitReachedAlertSubtitle", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false) ), okButton = ButtonConfiguration( text = "?cameraLimitReachedOkButtonTitle", accessibilityDescription = "?accessibilityDescriptionCameraLimitReachedOkButton", background = BackgroundStyle( fillColor = ScanbotColor("?sbColorPrimary", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) ), cancelButton = ButtonConfiguration( visible = false ) ), var cancelAlertDialog: ScanbotAlertDialog = ScanbotAlertDialog( title = StyledText( text = "?cameraCancelAlertTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), subtitle = StyledText( text = "?cameraCancelAlertSubtitle", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false) ), okButton = ButtonConfiguration( text = "?cameraCancelYesButtonTitle", accessibilityDescription = "?accessibilityDescriptionCameraCancelYesButton", background = BackgroundStyle( fillColor = ScanbotColor("?sbColorPrimary", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) ), cancelButton = ButtonConfiguration( text = "?cameraCancelNoButtonTitle", accessibilityDescription = "?accessibilityDescriptionCameraCancelNoButton", background = BackgroundStyle( fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( color = ScanbotColor("?sbColorPrimary", isArgb = false) ) ) )) : Parcelable

Configuration of the screen for scanning the pages with the camera.

Constructors

constructor(source: Map<String, Any?>)

constructor(json: JSONObject)

constructor(acknowledgement: AcknowledgementScreenConfiguration = AcknowledgementScreenConfiguration( ), introduction: IntroductionScreenConfiguration = IntroductionScreenConfiguration( ), scanAssistanceOverlay: ScanAssistanceOverlay = ScanAssistanceOverlay( ), 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) ) ), topBarTitle: StyledText = StyledText( text = "?cameraTopBarTitle", color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), topBarIntroButton: IconButton = IconButton( color = ScanbotColor("?sbColorOnPrimary", isArgb = false), accessibilityDescription = "?accessibilityDescriptionCameraTopBarIntroButton" ), topBarBackButton: ButtonConfiguration = ButtonConfiguration( visible = true, text = "?cameraTopBarCancelButtonTitle", accessibilityDescription = "?accessibilityDescriptionCameraTopBarCancelButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( iconVisible = true, color = ScanbotColor("?sbColorOnPrimary", isArgb = false), useShadow = false ) ), topUserGuidance: UserGuidanceConfiguration = UserGuidanceConfiguration( title = StyledText( text = "?cameraTopGuidance", color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) ), userGuidance: DocumentScannerUserGuidance = DocumentScannerUserGuidance( ), backgroundColor: ScanbotColor = ScanbotColor("#000000FF", isArgb = false), autoRotateImages: Boolean = true, openReviewAfterEachScan: Boolean = false, cameraConfiguration: DocumentScannerCameraConfiguration = DocumentScannerCameraConfiguration( ), scannerParameters: DocumentScannerParameters = DocumentScannerParameters( ), polygon: DocumentPolygonConfiguration = DocumentPolygonConfiguration( ), bottomBar: CameraBottomBar = CameraBottomBar( ), viewFinder: ViewFinderConfiguration = ViewFinderConfiguration( aspectRatio = AspectRatio( width = 21.0, height = 29.0 ), visible = false ), captureFeedback: CaptureFeedback = CaptureFeedback( ), vibration: Vibration = Vibration( enabled = true ), timeouts: Timeouts = Timeouts( autoCancelTimeout = 0, initialScanDelay = 0 ), limitReachedAlertDialog: ScanbotAlertDialog = ScanbotAlertDialog( title = StyledText( text = "?cameraLimitReachedAlertTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), subtitle = StyledText( text = "?cameraLimitReachedAlertSubtitle", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false) ), okButton = ButtonConfiguration( text = "?cameraLimitReachedOkButtonTitle", accessibilityDescription = "?accessibilityDescriptionCameraLimitReachedOkButton", background = BackgroundStyle( fillColor = ScanbotColor("?sbColorPrimary", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) ), cancelButton = ButtonConfiguration( visible = false ) ), cancelAlertDialog: ScanbotAlertDialog = ScanbotAlertDialog( title = StyledText( text = "?cameraCancelAlertTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), subtitle = StyledText( text = "?cameraCancelAlertSubtitle", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false) ), okButton = ButtonConfiguration( text = "?cameraCancelYesButtonTitle", accessibilityDescription = "?accessibilityDescriptionCameraCancelYesButton", background = BackgroundStyle( fillColor = ScanbotColor("?sbColorPrimary", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) ), cancelButton = ButtonConfiguration( text = "?cameraCancelNoButtonTitle", accessibilityDescription = "?accessibilityDescriptionCameraCancelNoButton", background = BackgroundStyle( fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( color = ScanbotColor("?sbColorPrimary", isArgb = false) ) ) ))