BarcodeScannerConfiguration class

Constructors

BarcodeScannerConfiguration.new({Color? topBarBackgroundColor, Color? topBarButtonsColor, Color? cameraOverlayColor, Color? finderLineColor, Color? finderTextHintColor, String? cancelButtonTitle, String? enableCameraButtonTitle, String? enableCameraExplanationText, String? finderTextHint, int? autoCancelTimeout, FinderAspectRatio? finderAspectRatio, int? finderLineWidth, bool? successBeepEnabled, bool? flashEnabled, OrientationLockMode? orientationLockMode, List<BarcodeFormat>? barcodeFormats, List<BarcodeDocumentFormat>? acceptedDocumentFormats, bool? cancelButtonHidden, BarcodeImageGenerationType barcodeImageGenerationType = BarcodeImageGenerationType.NONE, BarcodeAdditionalParameters? additionalParameters, EngineMode engineMode = EngineMode.NEXT_GEN, double? cameraZoomFactor, bool? minFocusDistanceLock, Color? topBarButtonsInactiveColor, SelectionOverlayConfiguration? overlayConfiguration, bool? useButtonsAllCaps, String? flashButtonTitle})

Properties

acceptedDocumentFormats ↔ List<BarcodeDocumentFormat>?

Barcode formats which need to be recognized.

getter/setter pair

additionalParameters ↔ BarcodeAdditionalParameters?

Additional parameters for tweaking the detection of barcodes.

getter/setter pair

autoCancelTimeout ↔ int?

cancel scanning and close view on timeout.

getter/setter pair

barcodeFormats ↔ List<BarcodeFormat>?

Barcode formats which need to be recognized.

getter/setter pair

barcodeImageGenerationType ↔ BarcodeImageGenerationType

Param that handle whether we need to save image from camera preview or make a snapshot while snapping barcode image uri will be returned in BarcodeScanningResult.barcodeImageURI property

getter/setter pair

cameraOverlayColor ↔ Color?

Background color outside the finder window.

getter/setter pair

cameraZoomFactor ↔ double?

Set current zoom by a linear zoom value ranging from 0f to 1.0f. Optical Zoom Level 0f represents the minimum zoom while Optical Zoom Level 1.0f represents the maximum zoom. Default value is 0f.

getter/setter pair

cancelButtonHidden ↔ bool?

getter/setter pair

cancelButtonTitle ↔ String?

Title of the cancel button.

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

Type of engine to be used in barcode scanner

getter/setter pair

finderAspectRatio ↔ FinderAspectRatio?

Aspect ratio of finder view.

getter/setter pair

finderLineColor ↔ Color?

The color of the finder window's outline.

getter/setter pair

finderLineWidth ↔ int?

Thickness of the finder window's outline.

getter/setter pair

finderTextHint ↔ String?

Text hint shown under the finder window.

getter/setter pair

finderTextHintColor ↔ Color?

The color of the text hint under the finder window.

getter/setter pair

flashButtonTitle ↔ String?

String being displayed on the flash button. (ios only!)

getter/setter pair

flashEnabled ↔ bool?

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

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

minFocusDistanceLock ↔ bool?

Locks the minimal supported focus distance and disables a continuous focus Default value is false. Only Compatible with CameraX in Android

getter/setter pair

orientationLockMode ↔ OrientationLockMode?

Orientation lock mode of the camera: PORTRAIT or LANDSCAPE. By default the camera orientation is not locked.

getter/setter pair

overlayConfiguration ↔ SelectionOverlayConfiguration?

The selection overlay configuration.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

successBeepEnabled ↔ bool?

Controls whether to play a beep sound after a successful detection. Default value is TRUE.

getter/setter pair

topBarBackgroundColor ↔ Color?

Background color of the top toolbar.

getter/setter pair

topBarButtonsColor ↔ Color?

The color of the titles of all buttons in the top toolbar.

getter/setter pair

topBarButtonsInactiveColor ↔ Color?

Foreground color of the flash button when flash is off.

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

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