SparkScan View Settings
Defined under the namespace Scandit.Datacapture.Barcode.Spark.Ui
- SparkScanViewSettings
class SparkScanViewSettingsAdded in version 6.16.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.
- 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.
Deprecated since version 6.23.0: Replaced by inactiveStateTimeout.
- inactiveStateTimeout
inactiveStateTimeout: number
Added in version 6.23.0
The timeout to automatically stop capturing.
Default is 10 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.
- 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.
- toastSettings
toastSettings: SparkScanToastSettings
Added in version 6.19.0
Sets the toast settings. See SparkScanToastSettings for details.
- ignoreDragLimits
ignoreDragLimits: boolean
Added in version 6.19.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.
- zoomFactorOut
zoomFactorOut: number
Added in version 6.23.0
The zoom factor to use for the camera.
Default is 1.
- zoomFactorIn
zoomFactorIn: number
Added in version 6.23.0
The zoom factor to move to when the zoom switch control was tapped.
Default is 2.
- targetZoomFactorOut
targetZoomFactorOut: number
Added in version 6.19.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
targetZoomFactorIn: number
Added in version 6.19.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
defaultCameraPosition: CameraPosition
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.