CheckScannerJsonConfiguration

data class CheckScannerJsonConfiguration(var version: String? = null, var screen: String? = null, var acceptedCheckStandards: List<JsonCheckStandard>? = null, var cameraModule: JsonCameraModule? = null, var cameraOverlayColor: JsonColor? = null, var cancelButtonTitle: String? = null, var captureHighResolutionImage: Boolean? = null, var enableCameraButtonTitle: String? = null, var enableCameraExplanationText: String? = null, var finderAspectRatio: JsonAspectRatio? = null, var finderLineColor: JsonColor? = null, var finderLineWidth: Double? = null, var flashEnabled: Boolean? = null, var orientationLockMode: JsonOrientationLockMode? = null, var topBarBackgroundColor: JsonColor? = null, var topBarButtonsActiveColor: JsonColor? = null, var topBarButtonsInactiveColor: JsonColor? = null, var userGuidanceBackgroundColor: JsonColor? = null, var userGuidanceTextColor: JsonColor? = null, var userGuidanceStringValues: JsonCheckUserGuidanceStrings? = null, var useButtonsAllCaps: Boolean? = null, var cameraPreviewMode: JsonCameraPreviewMode? = null, var touchToFocusEnabled: Boolean? = null) : Parcelable

Constructors

Link copied to clipboard
constructor(version: String? = null, screen: String? = null, acceptedCheckStandards: List<JsonCheckStandard>? = null, cameraModule: JsonCameraModule? = null, cameraOverlayColor: JsonColor? = null, cancelButtonTitle: String? = null, captureHighResolutionImage: Boolean? = null, enableCameraButtonTitle: String? = null, enableCameraExplanationText: String? = null, finderAspectRatio: JsonAspectRatio? = null, finderLineColor: JsonColor? = null, finderLineWidth: Double? = null, flashEnabled: Boolean? = null, orientationLockMode: JsonOrientationLockMode? = null, topBarBackgroundColor: JsonColor? = null, topBarButtonsActiveColor: JsonColor? = null, topBarButtonsInactiveColor: JsonColor? = null, userGuidanceBackgroundColor: JsonColor? = null, userGuidanceTextColor: JsonColor? = null, userGuidanceStringValues: JsonCheckUserGuidanceStrings? = null, useButtonsAllCaps: Boolean? = null, cameraPreviewMode: JsonCameraPreviewMode? = null, touchToFocusEnabled: Boolean? = null)

Properties

Link copied to clipboard

Accepted check standards. Optional, by default - all checks are accepted. With an empty list no filter is applied and all checks are accepted.

Link copied to clipboard

The preferred camera module (default - BACK)

Link copied to clipboard

Background color outside of the finder window.

Link copied to clipboard

Preview mode of the camera. FILL_IN or FIT_IN. Default is FILL_IN. Android only

Link copied to clipboard

Title of the cancel button.

Link copied to clipboard

Set high-resolution Check image capturing. If set to TRUE a high-resolution photo of the check is captured to run the recognition on. Upon successful recognition the recognition result also contains a high-resolution image of the check. If set to FALSE, the video frames will be used for recognition and result image delivery. The default value is TRUE.

Link copied to clipboard

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

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

Aspect ratio of finder frame (width \ height), which is used to build actual finder frame. Default is 1 - it is a square frame, which is good for QR capturing.

Link copied to clipboard

Foreground color of the detection overlay.

Link copied to clipboard

Width of finder frame border. Default is 2.

Link copied to clipboard

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

Link copied to clipboard

UI Interface orientation lock mode

Link copied to clipboard

The configuration object should be applied for this screen

Link copied to clipboard

The background color of the top toolbar.

Link copied to clipboard

The color of all active toggle buttons in the toolbar.

Link copied to clipboard

The color of all inactive toggle buttons in the toolbar.

Link copied to clipboard

Whether touch-to-focus is enabled on camera preview. Enabled by default. Android only.

Link copied to clipboard

Controls whether buttons should use all capitals style, as defined by the Android Material Design. Defaults to TRUE. Android only.

Link copied to clipboard

The background color of the user guidance hints.

Link copied to clipboard

Configuration that helps to override default hint values.

Link copied to clipboard

The text color of the user guidance hints.

Link copied to clipboard

A version of the configuration object