Class CameraScreenConfiguration

Configuration of the acknowledgement screen.

Default Value

new AcknowledgementScreenConfiguration({});
Copy

The background color of the camera screen.

Default Value

"#000000FF";
Copy

Configuration of the bottom bar for the camera screen.

Default Value

new CameraBottomBar({});
Copy

Configuration of the camera behavior.

Default Value

new DocumentScannerCameraConfiguration({});
Copy

Configuration of the camera permission screen.

Default Value

new CameraPermissionScreen({
    "background": "?sbColorSurface",
    "iconBackground": "?sbColorOutline",
    "icon": new IconStyle({
        "visible": true,
        "color": "?sbColorOnSurface"
    }),
    "closeButton": new ButtonConfiguration({
        "visible": true,
        "text": "?cameraPermissionCloseButton",
        "accessibilityDescription": "?accessibilityDescriptionCameraPermissionCloseButton",
        "background": new BackgroundStyle({
            "strokeColor": "?sbColorPrimary",
            "fillColor": "?sbColorPrimary",
            "strokeWidth": 0.0
        }),
        "foreground": new ForegroundStyle({
            "iconVisible": true,
            "color": "?sbColorOnPrimary",
            "useShadow": false
        })
    }),
    "enableCameraTitle": new StyledText({
        "text": "?cameraPermissionEnableCameraTitle",
        "color": "?sbColorOnSurface"
    }),
    "enableCameraExplanation": new StyledText({
        "text": "?cameraPermissionEnableCameraExplanation",
        "color": "?sbColorOnSurfaceVariant"
    })
});
Copy

Configuration of the alert dialog displayed when the 'cancel' button is pressed.

Default Value

new ScanbotAlertDialog({
    "title": new StyledText({
        "text": "?cameraCancelAlertTitle",
        "color": "?sbColorOnSurface"
    }),
    "subtitle": new StyledText({
        "text": "?cameraCancelAlertSubtitle",
        "color": "?sbColorOnSurfaceVariant"
    }),
    "okButton": new ButtonConfiguration({
        "text": "?cameraCancelYesButtonTitle",
        "accessibilityDescription": "?accessibilityDescriptionCameraCancelYesButton",
        "background": new BackgroundStyle({
            "fillColor": "?sbColorPrimary",
            "strokeWidth": 0.0
        }),
        "foreground": new ForegroundStyle({
            "color": "?sbColorOnPrimary"
        })
    }),
    "cancelButton": new ButtonConfiguration({
        "text": "?cameraCancelNoButtonTitle",
        "accessibilityDescription": "?accessibilityDescriptionCameraCancelNoButton",
        "background": new BackgroundStyle({
            "fillColor": "#00000000",
            "strokeWidth": 0.0
        }),
        "foreground": new ForegroundStyle({
            "color": "?sbColorPrimary"
        })
    })
});
Copy

Configuration of the feedback shown after snapping a page.

Default Value

new CaptureFeedback({});
Copy

Configuration of the introduction screen.

Default Value

new IntroductionScreenConfiguration({});
Copy

Configuration of the alert dialog displayed when the scan limit is reached.

Default Value

new ScanbotAlertDialog({
    "title": new StyledText({
        "text": "?cameraLimitReachedAlertTitle",
        "color": "?sbColorOnSurface"
    }),
    "subtitle": new StyledText({
        "text": "?cameraLimitReachedAlertSubtitle",
        "color": "?sbColorOnSurfaceVariant"
    }),
    "okButton": new ButtonConfiguration({
        "text": "?cameraLimitReachedOkButtonTitle",
        "accessibilityDescription": "?accessibilityDescriptionCameraLimitReachedOkButton",
        "background": new BackgroundStyle({
            "fillColor": "?sbColorPrimary",
            "strokeWidth": 0.0
        }),
        "foreground": new ForegroundStyle({
            "color": "?sbColorOnPrimary"
        })
    }),
    "cancelButton": new ButtonConfiguration({
        "visible": false
    })
});
Copy

Configuration of the document contour detection polygon.

Default Value

new DocumentPolygonConfiguration({});
Copy

Configuration of the scan assistance overlay.

Default Value

new ScanAssistanceOverlay({});
Copy

Configuration of timeouts.

Default Value

new Timeouts({
    "autoCancelTimeout": 0,
    "initialScanDelay": 0
});
Copy

Configuration of the 'cancel' button, located in the top bar.

Default Value

new ButtonConfiguration({
    "visible": true,
    "text": "?cameraTopBarCancelButtonTitle",
    "accessibilityDescription": "?accessibilityDescriptionCameraTopBarCancelButton",
    "background": new BackgroundStyle({
        "strokeColor": "#00000000",
        "fillColor": "#00000000",
        "strokeWidth": 0.0
    }),
    "foreground": new ForegroundStyle({
        "iconVisible": true,
        "color": "?sbColorOnPrimary",
        "useShadow": false
    })
});
Copy

Configuration of the 'select camera' button, located in the top bar.

Default Value

new SelectCameraMenu({});
Copy

Configuration of the 'introduction' button, located in the top bar.

Default Value

new IconButton({
    "color": "?sbColorOnPrimary",
    "accessibilityDescription": "?accessibilityDescriptionCameraTopBarIntroButton"
});
Copy

Configuration of the title, located in the top bar.

Default Value

new StyledText({
    "text": "?cameraTopBarTitle",
    "color": "?sbColorOnPrimary"
});
Copy

Configuration of the static user guidance, located just below the top bar.

Default Value

new UserGuidanceConfiguration({
    "title": new StyledText({
        "text": "?cameraTopGuidance",
        "color": "?sbColorOnPrimary"
    })
});
Copy

Configuration of the hints guiding users through the scanning process.

Default Value

new DocumentScannerUserGuidance({});
Copy

Configuration of the scan confirmation vibration.

Default Value

new Vibration({
    "enabled": true
});
Copy

Configuration of the viewfinder.

Default Value

new ViewFinderConfiguration({
    "visible": false,
    "aspectRatio": new AspectRatio({
        "width": 21.0,
        "height": 29.0
    })
});
Copy