SparkScan View Settings
Defined in library scandit_datacapture_barcode_spark_ui
- SparkScanViewSettings
class SparkScanViewSettingsAdded in version 6.20.0
Warning
Changing the values of SparkScanViewSettings instance after the creation of SparkScanView does not result in applying the changed settings to the corresponding view.
- SparkScanViewSettings()
SparkScanViewSettings()Added in version 6.20.0
Constructs a new SparkScan view settings to use when creating an instance of the SparkScanView.
- triggerButtonCollapseTimeout
Duration triggerButtonCollapseTimeout
Added in version 6.20.0
The timeout to automatically switch to idle state. When set to negative value timeout is infinite.
Default is 5 seconds.
- inactiveStateTimeout
Duration inactiveStateTimeout
Added in version 6.22.0
The timeout to automatically stop capturing.
Default is 10 seconds.
- defaultScanningMode
SparkScanScanningMode defaultScanningMode
Added in version 6.20.0
Sets the default scanning mode of the view.
Default is SparkScanScanningModeDefault.
- defaultTorchState
TorchState defaultTorchState
Added in version 6.20.0
Sets the default torch state of the camera.
Default is TorchState.off.
- soundEnabled
bool soundEnabled
Added in version 6.20.0
Indicates whether the feedback should have sound enabled.
Default is true.
- hapticEnabled
bool hapticEnabled
Added in version 6.20.0
Indicates whether the feedback should have haptics enabled.
Default is true.
- holdToScanEnabled
bool holdToScanEnabled
Added in version 6.20.0
Indicates whether to keep scanning as long as the scan button is pressed.
Default is true.
- visualFeedbackEnabled
bool visualFeedbackEnabled
Added in version 6.20.0
Indicates whether the visual feedback on scan should be displayed.
Default is true.
- toastSettings
SparkScanToastSettings toastSettings
Added in version 6.20.0
Sets the toast settings. See SparkScanToastSettings for details.
- smartSelectionCandidateBrush
Brush? smartSelectionCandidateBrush
Added in version 8.1.0
Sets the brush to be used for potential candidates when ScanIntention is set to ScanIntention.smartSelection in SparkScanSettings. If null, the default brush will be used.
- zoomFactorOut
double zoomFactorOut
Added in version 6.23.0
The zoom factor to use for the camera.
Default is 1.
- zoomFactorIn
double zoomFactorIn
Added in version 6.23.0
The zoom factor to move to when the zoom switch control was tapped.
Default is 2.
- defaultMiniPreviewSize
SparkScanMiniPreviewSize defaultMiniPreviewSize
Added in version 7.0.0
Sets the default size of the mini preview.
Default is SparkScanMiniPreviewSize.regular.
- shouldShowOnTopAlways
bool shouldShowOnTopAlways
Added in version 6.23.0
Determines whether the SparkScanView should always be placed on top of the Flutter content. It only has an effect on iOS.
The default is true.
- defaultCameraPosition
CameraPosition defaultCameraPosition
Added in version 6.24.0
Sets the default camera position.
Default is CameraPosition.worldFacing.
Note
This API is still in beta and may change in future versions of Scandit Data Capture SDK.