SparkScan View Settings

Defined in library scandit_datacapture_barcode_spark_ui

SparkScanViewSettings
class SparkScanViewSettings

Added in version 6.20.0

SparkScanViewSettings()
SparkScanViewSettings()

Added in version 6.20.0

Constructs a new SparkScan view settings to use when creating an instance of the SparkScanView.

Warning

Changing the values of SparkScanViewSettings instance after the creation of SparkScanView does not result in applying the changed settings to the corresponding view.

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 infinite.

continuousCaptureTimeout
Duration continuousCaptureTimeout

Added in version 6.20.0

The timeout to automatically stop capturing when the view is configured in SparkScanScanningBehavior.continuous capturing mode.

Default is 60 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.

defaultHandMode
SparkScanViewHandMode defaultHandMode

Added in version 6.20.0

Sets the default hand mode of the view.

Default is SparkScanViewHandMode.right.

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.

hardwareTriggerEnabled
bool hardwareTriggerEnabled

Added in version 6.20.0

hardwareTriggerKeyCode
int? hardwareTriggerKeyCode

Added in version 6.20.0

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.

ignoreDragLimits
bool ignoreDragLimits

Added in version 6.20.0

If set to true the scan button will not be limited vertically in its movement. This makes it possible to interact with the part of the app that might otherwise be covered by it. If the button covers the camera preview when the scanner is started, it will be moved to just under the preview.

Default is true.

Deprecated since version 6.22.0: There is no drag limit anymore. Button can be repositioned all the way from the bottom to the top of the screen.

targetZoomFactorOut
double targetZoomFactorOut

Added in version 6.20.0

The zoom factor to use for the camera.

Default is 1.

targetZoomFactorIn
double targetZoomFactorIn

Added in version 6.20.0

The zoom factor to move to when the zoom in gesture was performed or zoom switch control was tapped.

Default is 2.