SparkScan View Settings

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

SparkScanViewSettings
class SparkScanViewSettings

Added in version 6.24.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.

constructor()
constructor()

Added in version 6.24.0

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

triggerButtonCollapseTimeout
triggerButtonCollapseTimeout: number

Added in version 6.24.0

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

Default is infinite.

inactiveStateTimeout
inactiveStateTimeout: number

Added in version 6.24.0

The timeout to automatically stop capturing.

Default is 10 seconds.

defaultScanningMode
defaultScanningMode: SparkScanScanningMode

Added in version 6.24.0

Sets the default scanning mode of the view.

Default is SparkScanScanningModeDefault.

defaultTorchState
defaultTorchState: TorchState

Added in version 6.24.0

Sets the default torch state of the camera.

Default is TorchState.Off.

soundEnabled
soundEnabled: boolean

Added in version 6.24.0

Indicates whether the feedback should have sound enabled.

Default is true.

hapticEnabled
hapticEnabled: boolean

Added in version 6.24.0

Indicates whether the feedback should have haptics enabled.

Default is true.

defaultHandMode
defaultHandMode: SparkScanViewHandMode

Added in version 6.24.0

Sets the default hand mode of the view.

Default is SparkScanViewHandMode.Right.

holdToScanEnabled
holdToScanEnabled: boolean

Added in version 6.24.0

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

Default is true.

visualFeedbackEnabled
visualFeedbackEnabled: boolean

Added in version 6.24.0

Indicates whether the visual feedback on scan should be displayed.

Default is true.

toastSettings
toastSettings: SparkScanToastSettings

Added in version 6.24.0

Sets the toast settings. See SparkScanToastSettings for details.

zoomFactorOut
zoomFactorOut: number

Added in version 6.24.0

The zoom factor to use for the camera.

Default is 1.

zoomFactorIn
zoomFactorIn: number

Added in version 6.24.0

The zoom factor to move to when the zoom switch control was tapped.

Default is 2.