CheckScannerConfiguration

Class which is used to configure CheckScannerActivity Contains settings indicating views Behaviour, Texts and Appearance

Constructors

Link copied to clipboard
constructor()

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Functions

Link copied to clipboard

Accepted checks.

Link copied to clipboard
fun setCameraModule(cameraModule: CameraModule)

Set supported camera module: CameraModule.BACK, CameraModule.FRONT or others. Optional. Default is CameraModule.BACK.

Link copied to clipboard
fun setCameraOverlayColor(cameraOverlayColor: Int)

Background color outside of the finder window.

Link copied to clipboard
fun setCameraPreviewMode(cameraPreviewMode: CameraPreviewMode)

Preview mode of the camera: Fit-In or Fill-In. Optional, default is Fill-In.

Link copied to clipboard
fun setCancelButtonTitle(cancelButtonTitle: String)

Title of the cancel button.

Link copied to clipboard
fun setCaptureHighResolutionImage(captureHighResolutionImage: Boolean)

Set high-resolution Check image capturing.

Link copied to clipboard
fun setEnableCameraButtonTitle(enableCameraButtonTitle: String)

Title of the button that opens the screen where the user can allow the usage of the camera by the app.

Link copied to clipboard
fun setEnableCameraExplanationText(enableCameraExplanationText: String)

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.

Link copied to clipboard
fun setFinderAspectRatio(finderAspectRatio: AspectRatio)

Aspect ratio of the finder window.

Link copied to clipboard
fun setFinderLineColor(finderLineColor: Int)

Color of the finder window's outline.

Link copied to clipboard
fun setFinderLineWidth(finderLineWidth: Int)

Thickness of the finder window's outline.

Link copied to clipboard
fun setFlashEnabled(flashEnabled: Boolean)

Controls whether the flash should be initially enabled. The default value is FALSE.

Link copied to clipboard
fun setOrientationLockMode(cameraOrientationMode: CameraOrientationMode)

Orientation lock mode of the camera: PORTRAIT or LANDSCAPE. By default the camera orientation is not locked.

Link copied to clipboard
fun setTopBarBackgroundColor(topBarBackgroundColor: Int)

Background color of the top toolbar.

Link copied to clipboard
fun setTopBarButtonsColor(topBarButtonsColor: Int)

Color of the titles of all buttons in the top toolbar.

Link copied to clipboard
fun setTopBarButtonsInactiveColor(topBarButtonsInactiveColor: Int)

Color of the titles of all inactive buttons in the top toolbar.

Link copied to clipboard

Controls whether the touch to focus feature should be enabled. Default is true.

Link copied to clipboard

Controls whether buttons should use all capitals style.

Link copied to clipboard
fun setUserGuidanceBackgroundColor(userGuidanceBackgroundColor: Int)

The background color of the user guidance hints.

Link copied to clipboard
fun setUserGuidanceStrings(startScanning: String? = null, scanning: String? = null, capturing: String? = null, processing: String? = null)

Configuration that helps to override default hint values.

Link copied to clipboard
fun setUserGuidanceTextColor(userGuidanceTextColor: Int)

The text color of the user guidance hints.