Android Scanbot SDK API reference/io.scanbot.sdk.ui.view.vin.configuration.json/VinScannerJsonConfiguration

VinScannerJsonConfiguration

data class VinScannerJsonConfiguration(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 finderTextHintColor: JsonColor? = null, var flashEnabled: Boolean? = null, var orientationLockMode: JsonOrientationLockMode? = null, var topBarBackgroundColor: JsonColor? = null, var topBarButtonsActiveColor: JsonColor? = null, var topBarButtonsInactiveColor: JsonColor? = null, var extractVINFromBarcode: Boolean? = null, var minimumNumberOfRequiredFramesWithEqualScanningResult: Int? = null, var maximumNumberOfAccumulatedFrames: Int? = null, var ocrResolutionLimit: Long? = null, var useButtonsAllCaps: Boolean? = null, var replaceCancelButtonWithIcon: Boolean? = null, var cameraPreviewMode: JsonCameraPreviewMode? = null, var touchToFocusEnabled: Boolean? = null, var aspectRatio: JsonAspectRatio? = null, var guidanceText: String? = null, var significantShakeDelay: Long? = 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, finderTextHintColor: JsonColor? = null, flashEnabled: Boolean? = null, orientationLockMode: JsonOrientationLockMode? = null, topBarBackgroundColor: JsonColor? = null, topBarButtonsActiveColor: JsonColor? = null, topBarButtonsInactiveColor: JsonColor? = null, extractVINFromBarcode: Boolean? = null, minimumNumberOfRequiredFramesWithEqualScanningResult: Int? = null, maximumNumberOfAccumulatedFrames: Int? = null, ocrResolutionLimit: Long? = null, useButtonsAllCaps: Boolean? = null, replaceCancelButtonWithIcon: Boolean? = null, cameraPreviewMode: JsonCameraPreviewMode? = null, touchToFocusEnabled: Boolean? = null, aspectRatio: JsonAspectRatio? = null, guidanceText: String? = null, significantShakeDelay: Long? = null)

Properties

aspectRatio

var aspectRatio: JsonAspectRatio?

The cameras zoom level preferred for this step. The actual zoom might be different from the preferred one to avoid clipping of finder area and maintain its aspect ratio and height

cameraModule

var cameraModule: JsonCameraModule?

The 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 usage of the camera by the app.

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.

extractVINFromBarcode

var extractVINFromBarcode: Boolean?

Controls whether the scanner should try to extract the VIN from possibly available barcodes. The default value is FALSE.

finderLineColor

var finderLineColor: JsonColor?

Foreground color of the detection overlay.

finderLineWidth

var finderLineWidth: Double?

Width of finder frame border. Default is 2.

finderTextHintColor

var finderTextHintColor: JsonColor?

Foreground color of the description label.

flashEnabled

var flashEnabled: Boolean?

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

guidanceText

var guidanceText: String?

User guidance hint text.

maximumNumberOfAccumulatedFrames

var maximumNumberOfAccumulatedFrames: Int?

Maximum number of accumulated frames to inspect before actual result is returned

minimumNumberOfRequiredFramesWithEqualScanningResult

var minimumNumberOfRequiredFramesWithEqualScanningResult: Int?

Minimum number of accumulated frames that have equal result

ocrResolutionLimit

var ocrResolutionLimit: Long?

The image will be downscaled to the given value during the processing. If the quality of the scanning is not enough, try to increase the limit. This variable affects the performance of the scanning process. Higher the size limit - better the quality, but the recognition is slower. 0 - do not rescale. Default value is 0.

orientationLockMode

var orientationLockMode: JsonOrientationLockMode?

UI Interface orientation lock mode

replaceCancelButtonWithIcon

var replaceCancelButtonWithIcon: Boolean?

If true, replaces the cancel button in the top bar with a back arrow icon. The default value is FALSE. Android only.

screen

var screen: String?

The configuration object should be applied for this screen

significantShakeDelay

var significantShakeDelay: Long?

Threshold used to pause the detection after significant movement occurred. Default = 0. Android only.