BarcodeScannerJsonConfiguration class

Implementers

• BarcodeScannerConfiguration

Annotations

• @JsonSerializable(includeIfNull: false, createFactory: false, explicitToJson: true)

Constructors

BarcodeScannerJsonConfiguration({String? version, String? screen, List<BarcodeDocumentFormat>? acceptedDocumentFormats, BarcodesExtensionFilter? barcodesExtensionFilter, Color? cameraOverlayColor, CameraModule? cameraModule, double? cameraZoomFactor, bool? cancelButtonHidden, String? cancelButtonTitle, EngineMode? engineMode, String? enableCameraButtonTitle, String? enableCameraExplanationText, Color? finderLineColor, double? finderLineWidth, String? finderTextHint, Color? finderTextHintColor, AspectRatio? finderAspectRatio, bool? flashButtonHidden, String? flashButtonTitle, Color? flashButtonInactiveColor, bool? flashEnabled, bool? focusLockEnabled, double? focusLockPosition, bool? touchToFocusEnabled, 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, Gs1HandlingMode? gs1HandlingMode, MSIPlesseyChecksumAlgorithm? msiPlesseyChecksumAlgorithm, bool? lowPowerMode, CodeDensity? codeDensity, BarcodeImageGenerationType? barcodeImageGenerationType, double? initialScanDelay, double? delayAfterScan, bool? doubleTapToZoomEnabled, bool? pinchToZoomEnabled, bool? shouldAnimateZooming, bool? viewFinderEnabled, ConfirmationDialogConfiguration? confirmationDialogConfiguration, 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.

getter/setter pair

autoCancelTimeout ↔ int?

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

getter/setter pair

barcodeFormats ↔ List<BarcodeFormat>?

Accepted barcode formats

getter/setter pair

barcodeImageGenerationType ↔ BarcodeImageGenerationType?

The type of barcode image generation.

getter/setter pair

barcodesExtensionFilter ↔ BarcodesExtensionFilter?

The extension filter for EAN and UPC barcodes.

getter/setter pair

cameraModule ↔ CameraModule?

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

getter/setter pair

cameraOverlayColor ↔ Color?

Background color of the detection overlay.

getter/setter pair

cameraPreviewMode ↔ CameraPreviewMode?

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

getter/setter pair

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.

getter/setter pair

cameraZoomRange ↔ ZoomRange?

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

getter/setter pair

cancelButtonHidden ↔ bool?

Whether the cancel button is hidden or not. iOS only.

getter/setter pair

cancelButtonTitle ↔ String?

String being displayed on the cancel button.

getter/setter pair

codeDensity ↔ CodeDensity?

The expected density of QR codes in an image.

getter/setter pair

confirmationDialogConfiguration ↔ ConfirmationDialogConfiguration?

The confirmation dialog configuration.

getter/setter pair

delayAfterScan ↔ double?

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

getter/setter pair

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 pair

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 pair

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 pair

engineMode ↔ EngineMode?

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

getter/setter pair

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 pair

finderLineColor ↔ Color?

Foreground color of the detection overlay.

getter/setter pair

finderLineWidth ↔ double?

Width of finder frame border. Default is 2.

getter/setter pair

finderTextHint ↔ String?

String being displayed as description.

getter/setter pair

finderTextHintColor ↔ Color?

Foreground color of the description label.

getter/setter pair

flashButtonHidden ↔ bool?

Controls whether the flash toggle button is hidden or not. iOS only.

getter/setter pair

flashButtonInactiveColor ↔ Color?

Foreground color of the flash button when flash is off.

getter/setter pair

flashButtonTitle ↔ String?

String being displayed on the flash button. iOS only.

getter/setter pair

flashEnabled ↔ bool?

Whether flash is toggled on or off.

getter/setter pair

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.

getter/setter pair

focusLockPosition ↔ double?

The position of the lens. Values can be between 0.0f (minimum focusing distance) and 1.0f (maximum focusing distance). The default value is 0.0 iOS only. For Android, minFocusDistanceLock can be used.

getter/setter pair

gs1HandlingMode ↔ Gs1HandlingMode?

The GS1 handling mode. The default value is PARSE.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

initialScanDelay ↔ double?

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

getter/setter pair

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 pair

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 pair

minFocusDistanceLock ↔ bool?

Lock focus distance withing minimum possible range

getter/setter pair

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 pair

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 pair

msiPlesseyChecksumAlgorithm ↔ MSIPlesseyChecksumAlgorithm?

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

getter/setter pair

orientationLockMode ↔ OrientationLockMode?

UI Interface orientation lock mode

getter/setter pair

overlayConfiguration ↔ SelectionOverlayConfiguration?

The selection overlay configuration.

getter/setter pair

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 pair

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 pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

screen ↔ String?

The configuration object should be applied for this screen

getter/setter pair

shouldAnimateZooming ↔ bool?

Defines, if zooming in or out should be animated. iOS only.

getter/setter pair

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 pair

successBeepEnabled ↔ bool?

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

getter/setter pair

topBarBackgroundColor ↔ Color?

Background color of the top bar.

getter/setter pair

topBarButtonsColor ↔ Color?

Foreground color of the cancel button.

getter/setter pair

touchToFocusEnabled ↔ bool?

Whether touch-to-focus is enabled on camera preview. Enabled by default. Android only.

getter/setter pair

useButtonsAllCaps ↔ bool?

Controls whether buttons should use all capitals style, as defined by the Android Material Design. Defaults to TRUE. Android only.

getter/setter pair

version ↔ String?

A version of the configuration object

getter/setter pair

viewFinderEnabled ↔ bool?

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

getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited