BarcodeScannerJsonConfiguration

data class BarcodeScannerJsonConfiguration(var version: String? = null, var screen: String? = null, var acceptedDocumentFormats: List<JsonBarcodeDocumentFormat>? = null, var barcodesExtensionFilter: JsonBarcodesExtensionFilter? = null, var cameraOverlayColor: JsonColor? = null, var cameraModule: JsonCameraModule? = null, var cameraZoomFactor: Double? = null, var cancelButtonTitle: String? = null, var engineMode: JsonEngineMode? = 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 flashButtonInactiveColor: JsonColor? = null, var flashEnabled: Boolean? = null, var touchToFocusEnabled: Boolean? = null, var orientationLockMode: JsonOrientationLockMode? = null, var minimumTextLength: Int? = null, var maximumTextLength: Int? = null, var minFocusDistanceLock: Boolean? = null, var minimum1DBarcodesQuietZone: Int? = null, var stripCheckDigits: Boolean? = null, var useIATA2OF5Checksum: Boolean? = null, var useCode11Checksum: Boolean? = null, var successBeepEnabled: Boolean? = null, var topBarBackgroundColor: JsonColor? = null, var topBarButtonsColor: JsonColor? = null, var barcodeFormats: List<JsonBarcodeFormat>? = null, var useButtonsAllCaps: Boolean? = null, var replaceCancelButtonWithIcon: Boolean? = null, var cameraPreviewMode: JsonCameraPreviewMode? = null, var cameraZoomRange: JsonZoomRange? = null, var autoCancelTimeout: Int? = null, var gs1HandlingMode: JsonGs1HandlingMode? = null, var msiPlesseyChecksumAlgorithm: JsonMSIPlesseyChecksumAlgorithm? = null, var australiaPostCustomerFormat: JsonAustraliaPostCustomerFormat? = null, var lowPowerMode: Boolean? = null, var barcodeImageGenerationType: JsonBarcodeImageGenerationType? = null, var initialScanningDelay: Double? = null, var delayAfterScan: Double? = null, var viewFinderEnabled: Boolean? = null, var confirmationDialogConfiguration: JsonConfirmationDialogConfiguration? = null, var overlayConfiguration: JsonSelectionOverlayConfiguration? = null) : Parcelable

Constructors

Link copied to clipboard
constructor(version: String? = null, screen: String? = null, acceptedDocumentFormats: List<JsonBarcodeDocumentFormat>? = null, barcodesExtensionFilter: JsonBarcodesExtensionFilter? = null, cameraOverlayColor: JsonColor? = null, cameraModule: JsonCameraModule? = null, cameraZoomFactor: Double? = null, cancelButtonTitle: String? = null, engineMode: JsonEngineMode? = null, enableCameraButtonTitle: String? = null, enableCameraExplanationText: String? = null, finderLineColor: JsonColor? = null, finderLineWidth: Double? = null, finderTextHint: String? = null, finderTextHintColor: JsonColor? = null, finderAspectRatio: JsonAspectRatio? = null, flashButtonInactiveColor: JsonColor? = null, flashEnabled: Boolean? = null, touchToFocusEnabled: Boolean? = null, orientationLockMode: JsonOrientationLockMode? = null, minimumTextLength: Int? = null, maximumTextLength: Int? = null, minFocusDistanceLock: Boolean? = null, minimum1DBarcodesQuietZone: Int? = null, stripCheckDigits: Boolean? = null, useIATA2OF5Checksum: Boolean? = null, useCode11Checksum: Boolean? = null, successBeepEnabled: Boolean? = null, topBarBackgroundColor: JsonColor? = null, topBarButtonsColor: JsonColor? = null, barcodeFormats: List<JsonBarcodeFormat>? = null, useButtonsAllCaps: Boolean? = null, replaceCancelButtonWithIcon: Boolean? = null, cameraPreviewMode: JsonCameraPreviewMode? = null, cameraZoomRange: JsonZoomRange? = null, autoCancelTimeout: Int? = null, gs1HandlingMode: JsonGs1HandlingMode? = null, msiPlesseyChecksumAlgorithm: JsonMSIPlesseyChecksumAlgorithm? = null, australiaPostCustomerFormat: JsonAustraliaPostCustomerFormat? = null, lowPowerMode: Boolean? = null, barcodeImageGenerationType: JsonBarcodeImageGenerationType? = null, initialScanningDelay: Double? = null, delayAfterScan: Double? = null, viewFinderEnabled: Boolean? = null, confirmationDialogConfiguration: JsonConfirmationDialogConfiguration? = null, overlayConfiguration: JsonSelectionOverlayConfiguration? = null)

Properties

Link copied to clipboard

An optional array of barcode document formats that act as a detection filter. By default all supported document formats will be detected.

Link copied to clipboard

The customer format used in AUSTRALIA_POST codes. Only relevant for format codes 59 and 62. The default value is ALPHA_NUMERIC.

Link copied to clipboard

Sets auto close timer in seconds. 0 = disabled and it is the default value.

Link copied to clipboard

Accepted barcode formats

Link copied to clipboard

The type of barcode image generation.

Link copied to clipboard

The extension filter for EAN and UPC barcodes.

Link copied to clipboard

The camera module to be used for barcode scanning. The default value is BACK.

Link copied to clipboard

Background color of the detection overlay.

Link copied to clipboard

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

Link copied to clipboard

The relative initial zoom level of the camera in the range (0,1), where 0 is zoomed out and 1 is zoomed in. Default value is 0.0.

Link copied to clipboard

The range of valid camera zoom factors. Default value is (1.0; 12.0).

Link copied to clipboard

String being displayed on the cancel button.

Link copied to clipboard

The confirmation dialog configuration.

Link copied to clipboard

Freezes a preview after a scan for a given amount of seconds. Defaults to 0 secs. Android only.

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

The engine mode to be used for barcode scanning. The default value is NEXT_GEN.

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

String being displayed as description.

Link copied to clipboard

Foreground color of the description label.

Link copied to clipboard

Foreground color of the flash button when flash is off.

Link copied to clipboard

Whether flash is toggled on or off.

Link copied to clipboard

The GS1 handling mode. The default value is PARSE.

Link copied to clipboard

Scanning delay after scanner appearance in seconds. Defaults to 0 secs.

Link copied to clipboard

If true, enabled the mode which slightly decreases the scanning quality and the energy consumption, and increases the scanning speed. If false - mode is disabled. The default is false. Android only.

Link copied to clipboard

Optional maximum text length of the detected barcode. The default is 0 (setting is turned off). NOTE - This feature works on ITF barcodes only.

Link copied to clipboard

Lock focus distance withing minimum possible range

Link copied to clipboard

Optional minimum required quiet zone on the barcode. Measured in modules (the size of minimal bar on the barcode). The default is 10. NOTE - This feature works on ITF barcodes only.

Link copied to clipboard

Optional minimum required text length of the detected barcode. The default is 0 (setting is turned off). NOTE - This feature works on ITF barcodes only.

Link copied to clipboard

The checksum algorithm for MSI Plessey barcodes. The default value is MOD_10.

Link copied to clipboard

UI Interface orientation lock mode

Link copied to clipboard

The selection overlay configuration.

Link copied to clipboard

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

Link copied to clipboard

The configuration object should be applied for this screen

Link copied to clipboard

With this option enabled, the scanner removes checks digits for UPC, EAN and MSI Plessey codes. Has no effect if both single and double digit MSI Plessey checksums are enabled. The default is false

Link copied to clipboard

Whether scanner screen should make a sound on successful barcode or MRZ detection.

Link copied to clipboard

Background color of the top bar.

Link copied to clipboard

Foreground color of the cancel button.

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

If true, the optional check digit for CODE_11 codes is used in validation. The default is true.

Link copied to clipboard

If true, the optional check digit for IATA_2_OF_5 codes is used in validation. The default is true.

Link copied to clipboard

A version of the configuration object

Link copied to clipboard

Display the region of interest. The default value is TRUE.