SparkScan View Settings
Defined in framework ScanditBarcodeCapture
- SparkScanViewSettings
open class SparkScanViewSettings : NSObject
Added in version 6.15.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.
- init
init()
Added in version 6.15.0
Constructs a new SparkScan view settings to use when creating an instance of the SparkScanView.
- triggerButtonCollapseTimeout
open var triggerButtonCollapseTimeout: TimeInterval { get, set }
Added in version 6.15.0
The timeout to automatically switch to idle state. When set to negative value timeout is infinite.
Default is 5 seconds.
- inactiveStateTimeout
open var inactiveStateTimeout: TimeInterval { get, set }
Added in version 6.23.0
The timeout to automatically stop capturing.
Default is 10 seconds.
- defaultScanningMode
open var defaultScanningMode: any SparkScanScanningMode { get, set }
Added in version 6.16.0
Sets the default scanning mode of the view.
Default is SparkScanScanningModeDefault.
- defaultTorchState
open var defaultTorchState: TorchState { get, set }
Added in version 6.15.0
Sets the default torch state of the camera.
Default is TorchState.off.
- isSoundEnabled
open var isSoundEnabled:
Bool{ get, set }Added in version 6.16.0
Indicates whether the feedback should have sound enabled.
Default is true.
- isHapticEnabled
open var isHapticEnabled:
Bool{ get, set }Added in version 6.16.0
Indicates whether the feedback should have haptics enabled.
Default is true.
- isHoldToScanEnabled
open var isHoldToScanEnabled:
Bool{ get, set }Added in version 6.16.0
Indicates whether to keep scanning as long as the scan button is pressed.
Default is true.
- isHardwareTriggerEnabled
open var isHardwareTriggerEnabled:
Bool{ get, set }Added in version 6.16.0
Sets whether the SparkScanView should react to clicks of the volume button. Disabled by default.
- isVisualFeedbackEnabled
open var isVisualFeedbackEnabled:
Bool{ get, set }Added in version 6.16.0
Indicates whether the visual feedback on scan should be displayed.
Default is true.
- toastSettings
open var toastSettings: SDCSparkScanToastSettings { get, set }
Added in version 6.18.0
Sets the toast settings. See SDCSparkScanToastSettings for details.
- smartSelectionCandidateBrush
open var smartSelectionCandidateBrush: Brush? { get, set }
Added in version 8.1.0
Sets the brush to be used for potential candidates when ScanIntention is set to ScanIntention.smartSelection in SparkScanSettings. If null, the default brush will be used.
- jsonString
open var jsonString: String { get }
Added in version 6.16.0
Returns the JSON representation of the spark scan settings.
- zoomFactorOut
open var zoomFactorOut: CGFloat { get, set }
Added in version 6.23.0
The zoom factor to use for the camera.
Default is 1.
- zoomFactorIn
open var zoomFactorIn: CGFloat { get, set }
Added in version 6.23.0
The zoom factor to move to when the zoom switch control was tapped.
Default is 2.
- defaultMiniPreviewSize
open var defaultMiniPreviewSize: SparkScanMiniPreviewSize { get, set }
Added in version 7.0.0
Sets the default size of the mini preview.
Default is SparkScanMiniPreviewSize.regular.
- defaultCameraPosition
open var defaultCameraPosition: CameraPosition { 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.
- isPeriscopeModeEnabled
open var isPeriscopeModeEnabled:
Bool{ get, set }Added in version 7.1.0
Controls the mirroring of the camera feed to support the use of a periscope device.
Default is false.