BarcodeScannerJsonConfiguration class
- Annotations
-
- @JsonSerializable(includeIfNull: false, createFactory: false, explicitToJson: true)
Constructors
-
BarcodeScannerJsonConfiguration({String? version, String? screen, List<BarcodeDocumentFormat>? acceptedDocumentFormats, Color? cameraOverlayColor, CameraModule? cameraModule, double? cameraZoomFactor, bool? cancelButtonHidden, String? cancelButtonTitle, EngineMode? engineMode, String? enableCameraButtonTitle, String? enableCameraExplanationText, Color? finderLineColor, double? finderLineWidth, String? finderTextHint, Color? finderTextHintColor, FinderAspectRatio? finderAspectRatio, bool? flashButtonHidden, String? flashButtonTitle, Color? flashButtonInactiveColor, bool? flashEnabled, bool? focusLockEnabled, double? focusLockPosition, OrientationLockMode? orientationLockMode, int? minimumTextLength, int? maximumTextLength, bool? minFocusDistanceLock, int? minimum1DBarcodesQuietZone, bool? stripCheckDigits, bool? successBeepEnabled, Color? topBarBackgroundColor, Color? topBarButtonsColor, List<BarcodeFormat>? barcodeFormats, bool? useButtonsAllCaps, bool? replaceCancelButtonWithIcon, CameraPreviewMode? cameraPreviewMode, ZoomRange? cameraZoomRange, int? autoCancelTimeout, bool? gs1DecodingEnabled, MSIPlesseyChecksumAlgorithm? msiPlesseyChecksumAlgorithm, bool? lowPowerMode, CodeDensity? codeDensity, BarcodeImageGenerationType? barcodeImageGenerationType, double? initialScanDelay, double? delayAfterScan, bool? doubleTapToZoomEnabled, bool? pinchToZoomEnabled, bool? shouldAnimateZooming, SelectionOverlayConfiguration? overlayConfiguration})
-
Properties
-
acceptedDocumentFormats
↔ List<BarcodeDocumentFormat>?
-
An optional array of barcode document formats that act as a detection filter. By default all supported document formats will be detected.
read / write
-
autoCancelTimeout
↔ int?
-
Sets auto close timer in seconds. 0 = disabled and it is the default value. Android only
read / write
-
barcodeFormats
↔ List<BarcodeFormat>?
-
Accepted barcode formats
read / write
-
barcodeImageGenerationType
↔ BarcodeImageGenerationType?
-
The type of barcode image generation.
read / write
-
cameraModule
↔ CameraModule?
-
Background color of the detection overlay.
read / write
-
cameraOverlayColor
↔ Color?
-
Background color of the detection overlay.
read / write
-
cameraPreviewMode
↔ CameraPreviewMode?
-
Preview mode of the camera. FILL_IN or FIT_IN. Default is FILL_IN. Android only
read / write
-
cameraZoomFactor
↔ double?
-
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.
read / write
-
cameraZoomRange
↔ ZoomRange?
-
The range of valid camera zoom factors. Default value is (1.0; 3.0). iOS only. For Android, minFocusDistanceLock can be used.
read / write
-
cancelButtonHidden
↔ bool?
-
Whether the cancel button is hidden or not. iOS only.
read / write
-
cancelButtonTitle
↔ String?
-
String being displayed on the cancel button.
read / write
-
codeDensity
↔ CodeDensity?
-
The expected density of QR codes in an image.
read / write
-
delayAfterScan
↔ double?
-
Freezes a preview after a scan for a given amount of seconds. Defaults to 0 secs. Android only.
read / write
-
doubleTapToZoomEnabled
↔ bool?
-
When this property is set to true, the zoom can be activated by double tapping somewhere in the receivers view. iOS only.
read / write
-
enableCameraButtonTitle
↔ String?
-
Title of the button that opens the screen where the user can allow the usage of the camera by the app.
read / write
-
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.
read / write
-
engineMode
↔ EngineMode?
-
String being displayed on the cancel button.
read / write
-
finderAspectRatio
↔ FinderAspectRatio?
-
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.
read / write
-
finderLineColor
↔ Color?
-
Foreground color of the detection overlay.
read / write
-
finderLineWidth
↔ double?
-
Width of finder frame border. Default is 2.
read / write
-
finderTextHint
↔ String?
-
String being displayed as description.
read / write
-
finderTextHintColor
↔ Color?
-
Foreground color of the description label.
read / write
-
flashButtonHidden
↔ bool?
-
Controls whether the flash toggle button is hidden or not.
read / write
-
flashButtonInactiveColor
↔ Color?
-
Foreground color of the flash button when flash is off.
read / write
-
flashButtonTitle
↔ String?
-
String being displayed on the flash button.
read / write
-
flashEnabled
↔ bool?
-
Whether flash is toggled on or off.
read / write
-
focusLockEnabled
↔ bool?
-
Disables auto-focus and locks the lens at the specified focus lock lens position. Default value is false. iOS only. For Android, minFocusDistanceLock can be used.
read / write
-
focusLockPosition
↔ double?
-
The position of the lens. Values can be between 0.0f (minimum focusing distance) and 1.0f (maximum focusing distance). The value will be clamped to (0.0f, 1.0f). The default value is 0.0. iOS only. For Android, minFocusDistanceLock can be used.
read / write
-
gs1DecodingEnabled
↔ bool?
-
When set to
true
, the scanner assumes that the barcode can be a GS1 barcode. Turn it off, if you don't want to see decoded FNC1 characters ("]C1" and ASCII char 29). The default value is true
. NOTE - Currently works for CODE128 barcodes only!
read / write
-
hashCode
→ int
-
The hash code for this object.
read-onlyinherited
-
initialScanDelay
↔ double?
-
Scanning delay after scanner appearance in seconds. Defaults to 0 secs.
read / write
-
lowPowerMode
↔ bool?
-
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.
read / write
-
maximumTextLength
↔ int?
-
Optional maximum text length of the detected barcode. The default is 0 (setting is turned off). NOTE - This feature works on ITF barcodes only.
read / write
-
minFocusDistanceLock
↔ bool?
-
Lock focus distance withing minimum possible range
read / write
-
minimum1DBarcodesQuietZone
↔ int?
-
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.
read / write
-
minimumTextLength
↔ int?
-
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.
read / write
-
msiPlesseyChecksumAlgorithm
↔ MSIPlesseyChecksumAlgorithm?
-
The checksum algorithm for MSI Plessey barcodes. The default value is Mod10.
read / write
-
orientationLockMode
↔ OrientationLockMode?
-
UI Interface orientation lock mode
read / write
-
overlayConfiguration
↔ SelectionOverlayConfiguration?
-
The selection overlay configuration.
read / write
-
pinchToZoomEnabled
↔ bool?
-
When this property is set to true, the zoom can be activated by a pinch gesture somewhere in the receivers view. iOS only.
read / write
-
replaceCancelButtonWithIcon
↔ bool?
-
If
true
, replaces the cancel button in the top bar with a back arrow icon. The default value is FALSE. Android only.
read / write
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
read-onlyinherited
-
screen
↔ String?
-
The configuration object should be applied for this screen
read / write
-
shouldAnimateZooming
↔ bool?
-
Defines, if zooming in or out should be animated. iOS only.
read / write
-
stripCheckDigits
↔ bool?
-
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
read / write
-
successBeepEnabled
↔ bool?
-
Whether scanner screen should make a sound on successful barcode or MRZ detection.
read / write
-
topBarBackgroundColor
↔ Color?
-
Background color of the top bar.
read / write
-
topBarButtonsColor
↔ Color?
-
Foreground color of the cancel button.
read / write
-
useButtonsAllCaps
↔ bool?
-
Controls whether buttons should use all capitals style, as defined by the Android Material Design. Defaults to TRUE. Android only.
read / write
-
version
↔ String?
-
A version of the configuration object
read / write