SparkScan View Settings

Defined in namespace Scandit.DataCapture.Barcode.Spark.UI

SparkScanViewSettings

class SparkScanViewSettings

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

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

TriggerButtonCollapseTimeout

TimeSpan TriggerButtonCollapseTimeout { get;set; }

Added in version 6.22.0

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

Default is infinite.

ContinuousCaptureTimeout

TimeSpan ContinuousCaptureTimeout { get;set; }

Added in version 6.22.0

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

Default is 60 seconds.

InactiveStateTimeout

TimeSpan InactiveStateTimeout { get;set; }

Added in version 6.23.0

The timeout to automatically stop capturing.

Default is 10 seconds.

DefaultScanningMode

ISparkScanScanningMode DefaultScanningMode { get;set; }

Added in version 6.22.0

Sets the default scanning mode of the view.

Default is SparkScanScanningModeDefault.

DefaultTorchState

TorchState DefaultTorchState { get;set; }

Added in version 6.22.0

Sets the default torch state of the camera.

Default is TorchState.Off.

SoundEnabled

bool SoundEnabled { get;set; }

Added in version 6.22.0

Indicates whether the feedback should have sound enabled.

Default is true.

HapticEnabled

bool HapticEnabled { get;set; }

Added in version 6.22.0

Indicates whether the feedback should have haptics enabled.

Default is true.

DefaultHandMode

SparkScanViewHandMode DefaultHandMode { get;set; }

Added in version 6.22.0

Sets the default hand mode of the view.

Default is SparkScanViewHandMode.Right.

HoldToScanEnabled

bool HoldToScanEnabled { get;set; }

Added in version 6.22.0

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

Default is true.

HardwareTriggerEnabled

bool HardwareTriggerEnabled { get;set; }

Added in version 6.22.0

Sets whether the SparkScanView should react to clicks on the hardware button specified in HardwareTriggerKeyCode. Disabled by default.

Note

This feature is only available on devices with api >= 28. Whether a device supports this can be checked at runtime with the SparkScanView.HardwareTriggerSupported flag.

HardwareTriggerKeyCode

int HardwareTriggerKeyCode { get;set; }

Added in version 6.22.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 Keycode.VolumeDown for other devices). This is only taken into consideration if HardwareTriggerEnabled is true.

VisualFeedbackEnabled

bool VisualFeedbackEnabled { get;set; }

Added in version 6.22.0

Indicates whether the visual feedback on scan should be displayed.

Default is true.

ToastSettings

SparkScanToastSettings ToastSettings { get;set; }

Added in version 6.22.0

Sets the toast settings. See SparkScanToastSettings for details.

ZoomFactorOut

float ZoomFactorOut { get;set; }

Added in version 6.23.0

The zoom factor to use for the camera.

Default is 1.

ZoomFactorIn

float ZoomFactorIn { get;set; }

Added in version 6.23.0

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

Default is 2.

TargetZoomFactorOut

float TargetZoomFactorOut { get;set; }

Added in version 6.22.0

The zoom factor to use for the camera.

Default is 1.

Deprecated since version 6.23.0: Replaced by ZoomFactorOut because zoom switch control is now also available in SparkScanScanningModeDefault scanning mode.

TargetZoomFactorIn

float TargetZoomFactorIn { get;set; }

Added in version 6.22.0

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

Default is 2.

Deprecated since version 6.23.0: Replaced by ZoomFactorIn because zoom switch control is now also available in SparkScanScanningModeDefault scanning mode.

DefaultCameraPosition

CameraPosition DefaultCameraPosition { get;set; }

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.