Android Scanbot SDK API reference/io.scanbot.sdk.ui.view.mrz.configuration.json/MrzScannerJsonConfiguration

MrzScannerJsonConfiguration

data class MrzScannerJsonConfiguration(var version: String? = null, var screen: String? = null, var cameraModule: JsonCameraModule? = null, var cameraOverlayColor: JsonColor? = null, var cancelButtonTitle: String? = null, var enableCameraButtonTitle: String? = null, var enableCameraExplanationText: String? = null, var finderLineColor: JsonColor? = null, var finderLineWidth: Double? = null, var finderTextHint: String? = null, var finderTextHintColor: JsonColor? = null, var finderAspectRatio: JsonAspectRatio? = null, var flashEnabled: Boolean? = null, var orientationLockMode: JsonOrientationLockMode? = null, var successBeepEnabled: Boolean? = null, var topBarBackgroundColor: JsonColor? = null, var topBarButtonsActiveColor: JsonColor? = null, var topBarButtonsInactiveColor: JsonColor? = null, var useButtonsAllCaps: Boolean? = null, var replaceCancelButtonWithIcon: Boolean? = null, var cameraPreviewMode: JsonCameraPreviewMode? = null, var touchToFocusEnabled: Boolean? = null) : Parcelable

Constructors

constructor(version: String? = null, screen: String? = null, cameraModule: JsonCameraModule? = null, cameraOverlayColor: JsonColor? = null, cancelButtonTitle: String? = null, enableCameraButtonTitle: String? = null, enableCameraExplanationText: String? = null, finderLineColor: JsonColor? = null, finderLineWidth: Double? = null, finderTextHint: String? = null, finderTextHintColor: JsonColor? = null, finderAspectRatio: JsonAspectRatio? = null, flashEnabled: Boolean? = null, orientationLockMode: JsonOrientationLockMode? = null, successBeepEnabled: Boolean? = null, topBarBackgroundColor: JsonColor? = null, topBarButtonsActiveColor: JsonColor? = null, topBarButtonsInactiveColor: JsonColor? = null, useButtonsAllCaps: Boolean? = null, replaceCancelButtonWithIcon: Boolean? = null, cameraPreviewMode: JsonCameraPreviewMode? = null, touchToFocusEnabled: Boolean? = null)

Properties

cameraModule

var cameraModule: JsonCameraModule?

Preferred camera module (Default: BACK).

cameraOverlayColor

var cameraOverlayColor: JsonColor?

Background color outside of the finder window.

cameraPreviewMode

var cameraPreviewMode: JsonCameraPreviewMode?

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

cancelButtonTitle

var cancelButtonTitle: String?

Title of the cancel button.

enableCameraButtonTitle

var enableCameraButtonTitle: String?

Title of the button that opens the screen where the user can allow the app to use the camera.

enableCameraExplanationText

var 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.

finderAspectRatio

var finderAspectRatio: JsonAspectRatio?

Aspect ratio of the finder frame (width to height), which is used to build the actual finder frame. Default is 7, which is good for standard machine readable zones.

finderLineColor

var finderLineColor: JsonColor?

Foreground color of the detection overlay.

finderLineWidth

var finderLineWidth: Double?

Width of the finder frame border. Default is 2.

finderTextHint

var finderTextHint: String?

String being displayed as a description.

finderTextHintColor

var finderTextHintColor: JsonColor?

Foreground color of the description label.