SparkScan View Settings

Defined under the namespace Scandit.Datacapture.Barcode.Spark.Ui

SparkScanViewSettings
class SparkScanViewSettings

Added in version 6.16.0

triggerButtonCollapseTimeout
triggerButtonCollapseTimeout: number

Added in version 6.16.0

The timeout to automatically switch to idle state. When set to negative value timeout is infinite.

Default is infinite.

continuousCaptureTimeout
continuousCaptureTimeout: number

Added in version 6.16.0

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

Default is 60 seconds.

defaultScanningMode
defaultScanningMode: SparkScanScanningMode

Added in version 6.16.0

Sets the default scanning mode of the view.

Default is SparkScanScanningModeDefault.

defaultTorchState
defaultTorchState: TorchState

Added in version 6.16.0

Sets the default torch state of the camera.

Default is TorchState.Off.

soundEnabled
soundEnabled: boolean

Added in version 6.16.0

Indicates whether the feedback should have sound enabled.

Default is true.

hapticEnabled
hapticEnabled: boolean

Added in version 6.16.0

Indicates whether the feedback should have haptics enabled.

Default is true.

defaultHandMode
defaultHandMode: SparkScanViewHandMode

Added in version 6.16.0

Sets the default hand mode of the view.

Default is SparkScanViewHandMode.Right.

holdToScanEnabled
holdToScanEnabled: boolean

Added in version 6.16.0

Indicates whether to keep scanning as long as the scan button is pressed.

Default is true.

hardwareTriggerEnabled
hardwareTriggerEnabled: boolean

Added in version 6.16.0

hardwareTriggerKeyCode
hardwareTriggerKeyCode: number | null

Added in version 6.16.0

The button that acts as a scan trigger. Leave null to use the default button (The default button will be the dedicated HW button on XCover devices, and “volume down” key for other devices). This is only taken into consideration if hardwareTriggerEnabled is true.

visualFeedbackEnabled
visualFeedbackEnabled: boolean

Added in version 6.16.0

Indicates whether the visual feedback on scan should be displayed.

Default is true.