BatchBarcodeScannerConfiguration class

Inheritance

Constructors

BatchBarcodeScannerConfiguration({List<BarcodeDocumentFormat>? acceptedDocumentFormats, Color? cameraOverlayColor, CameraModule? cameraModule, double? cameraZoomFactor, ZoomRange? cameraZoomRange, bool? cancelButtonHidden, String? cancelButtonTitle, bool? doubleTapToZoomEnabled, bool? pinchToZoomEnabled, bool? shouldAnimateZooming, EngineMode? engineMode, Color? finderLineColor, double? finderLineWidth, String? finderTextHint, Color? finderTextHintColor, AspectRatio? finderAspectRatio, bool? flashButtonHidden, String? flashButtonTitle, bool? flashEnabled, bool? focusLockEnabled, double? focusLockPosition, OrientationLockMode? orientationLockMode, int? minimumTextLength, int? maximumTextLength, int? minimum1DBarcodesQuietZone, bool? minFocusDistanceLock, bool? stripCheckDigits, bool? successBeepEnabled, Color? topBarBackgroundColor, Color? topBarButtonsColor, Color? topBarButtonsInactiveColor, List<BarcodeFormat>? barcodeFormats, bool? useButtonsAllCaps, bool? gs1DecodingEnabled, MSIPlesseyChecksumAlgorithm? msiPlesseyChecksumAlgorithm, bool? lowPowerMode, String? barcodesCountText, Color? barcodesCountTextColor, String? clearButtonTitle, Color? detailsActionColor, Color? detailsBackgroundColor, Color? detailsPrimaryColor, String? deleteButtonTitle, String? enableCameraButtonTitle, String? enableCameraExplanationText, String? fetchingStateText, String? noBarcodesTitle, String? submitButtonTitle, CodeDensity? codeDensity, bool? replaceCancelButtonWithIcon, CameraPreviewMode? cameraPreviewMode, int? autoCancelTimeout, double? initialScanDelay, bool? viewFinderEnabled, SelectionOverlayConfiguration? overlayConfiguration, BarcodeAdditionalParameters? additionalParameters, BarcodeDataFormatter? barcodeFormatter})

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.
getter/setter pairinherited
additionalParameters BarcodeAdditionalParameters?
Additional parameters for tweaking the detection of barcodes.
getter/setter pair
autoCancelTimeout int?
Sets auto close timer in seconds. 0 = disabled and it is the default value. Android only
getter/setter pairinherited
barcodeFormats List<BarcodeFormat>?
Accepted barcode formats
getter/setter pairinherited
barcodeFormatter BarcodeDataFormatter?
Change data representation for scanned list items
getter/setter pair
barcodesCountText String?
The color for barcodes count text
getter/setter pairinherited
barcodesCountTextColor Color?
The color for barcodes count text
getter/setter pairinherited
barcodesExtensionFilter BarcodesExtensionFilter?
The extension filter for EAN and UPC barcodes.
getter/setter pairinherited
cameraModule CameraModule?
Background color of the detection overlay.
getter/setter pairinherited
cameraOverlayColor Color?
Background color of the detection overlay.
getter/setter pairinherited
cameraPreviewMode CameraPreviewMode?
Preview mode of the camera. FILL_IN or FIT_IN. Default is FILL_IN. Android only
getter/setter pairinherited
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. The default value is 0.
getter/setter pairinherited
cameraZoomRange ZoomRange?
The range of valid camera zoom factors. Default value is (1.0; 12.0). iOS only.
getter/setter pairinherited
cancelButtonHidden bool?
Whether the cancel button is hidden or not. iOS only.
getter/setter pairinherited
cancelButtonTitle String?
String being displayed on the cancel button.
getter/setter pairinherited
clearButtonTitle String?
Text of the button which clears the list of scanned barcodes.
getter/setter pairinherited
codeDensity CodeDensity?
The expected density of QR codes in an image.
getter/setter pairinherited
deleteButtonTitle String?
String being displayed on the delete button. iOS only.
getter/setter pairinherited
detailsActionColor Color?
The color of Submit button
getter/setter pairinherited
detailsBackgroundColor Color?
The color of bottom sheet
getter/setter pairinherited
detailsPrimaryColor Color?
The color of text elements in bottom sheet
getter/setter pairinherited
doubleTapToZoomEnabled bool?
When this property is set to true, the zoom can be activated by double tapping somewhere in the receivers view. iOS only.
getter/setter pairinherited
enableCameraButtonTitle String?
Title of the button that opens the screen where the user can allow the usage of the camera by the app.
getter/setter pairinherited
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.
getter/setter pairinherited
engineMode EngineMode?
String being displayed on the cancel button.
getter/setter pairinherited
fetchingStateText String?
The text for the data fetching state of the barcode item in a list. Smth "Fetching info…"
getter/setter pairinherited
finderAspectRatio AspectRatio?
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.
getter/setter pairinherited
finderLineColor Color?
Foreground color of the detection overlay.
getter/setter pairinherited
finderLineWidth double?
Width of finder frame border. Default is 2.
getter/setter pairinherited
finderTextHint String?
String being displayed as description.
getter/setter pairinherited
finderTextHintColor Color?
Foreground color of the description label.
getter/setter pairinherited
flashButtonHidden bool?
Controls whether the flash toggle button is hidden or not.
getter/setter pairinherited
flashButtonTitle String?
String being displayed on the flash button.
getter/setter pairinherited
flashEnabled bool?
Whether flash is toggled on or off.
getter/setter pairinherited
focusLockEnabled bool?
Disables auto-focus and locks the lens at the specified focus lock lens position. The default value is false.
getter/setter pairinherited
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.
getter/setter pairinherited
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!
getter/setter pairinherited
hashCode int
The hash code for this object.
no setterinherited
initialScanDelay double?
Scanning delay after scanner appearance in seconds. Defaults to 0 secs.
getter/setter pairinherited
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.
getter/setter pairinherited
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.
getter/setter pairinherited
minFocusDistanceLock bool?
Lock focus distance withing minimum possible range
getter/setter pairinherited
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.
getter/setter pairinherited
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.
getter/setter pairinherited
msiPlesseyChecksumAlgorithm MSIPlesseyChecksumAlgorithm?
The checksum algorithm for MSI Plessey barcodes. The default value is MOD_10.
getter/setter pairinherited
noBarcodesTitle String?
Text of the message that there are no barcodes scanned
getter/setter pairinherited
orientationLockMode OrientationLockMode?
UI Interface orientation lock mode
getter/setter pairinherited
overlayConfiguration SelectionOverlayConfiguration?
The selection overay configuration.
getter/setter pairinherited
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.
getter/setter pairinherited
replaceCancelButtonWithIcon bool?
If true, replaces the cancel button in the top bar with a back arrow icon. The default value is FALSE. Android only.
getter/setter pairinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
screen String?
The configuration object should be applied for this screen
getter/setter pairoverride
shouldAnimateZooming bool?
Defines, if zooming in or out should be animated. iOS only.
getter/setter pairinherited
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
getter/setter pairinherited
submitButtonTitle String?
Text of the button which finishes the flow
getter/setter pairinherited
successBeepEnabled bool?
Whether scanner screen should make a sound on successful barcode or MRZ detection.
getter/setter pairinherited
topBarBackgroundColor Color?
Background color of the top bar.
getter/setter pairinherited
topBarButtonsColor Color?
Foreground color of the cancel button.
getter/setter pairinherited
topBarButtonsInactiveColor Color?
Foreground color of the top bar buttons when disabled.
getter/setter pairinherited
useButtonsAllCaps bool?
Controls whether buttons should use all capitals style, as defined by the Android Material Design. Defaults to TRUE. Android only.
getter/setter pairinherited
version String?
A version of the configuration object
getter/setter pairinherited
viewFinderEnabled bool?
Display the region of interest. The default value is TRUE.
getter/setter pairinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() Map<String, dynamic>
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited