SparkScan View Settings
Defined in framework ScanditBarcodeCapture
- SDCSparkScanViewSettings
@interface SDCSparkScanViewSettings : NSObject
Added in version 6.15.0
Warning
Changing the values of SparkScanViewSettings instance after the creation of SDCSparkScanView does not result in applying the changed settings to the corresponding view.
- triggerButtonCollapseTimeout
@property (nonatomic, assign) NSTimeInterval triggerButtonCollapseTimeout
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
@property (nonatomic, assign) NSTimeInterval inactiveStateTimeout
Added in version 6.23.0
The timeout to automatically stop capturing.
Default is 10 seconds.
- defaultScanningMode
@property (nonatomic, strong)
id<SDCSparkScanScanningMode> defaultScanningModeAdded in version 6.16.0
Sets the default scanning mode of the view.
Default is SDCSparkScanScanningModeDefault.
- defaultTorchState
@property (nonatomic, assign) SDCTorchState defaultTorchState
Added in version 6.15.0
Sets the default torch state of the camera.
Default is SDCTorchStateOff.
- soundEnabled
@property (nonatomic, assign, getter=isSoundEnabled)
BOOLsoundEnabledAdded in version 6.16.0
Indicates whether the feedback should have sound enabled.
Default is YES.
- hapticEnabled
@property (nonatomic, assign, getter=isHapticEnabled)
BOOLhapticEnabledAdded in version 6.16.0
Indicates whether the feedback should have haptics enabled.
Default is YES.
- defaultHandMode
@property (nonatomic, assign) SDCSparkScanViewHandMode defaultHandMode
Added in version 6.15.0
Sets the default hand mode of the view.
Default is SDCSparkScanViewHandModeRight.
Deprecated since version 7.0: Hand mode is no longer supported. The trigger button can now be placed anywhere on the screen.
- holdToScanEnabled
@property (nonatomic, assign, getter=isHoldToScanEnabled)
BOOLholdToScanEnabledAdded in version 6.16.0
Indicates whether to keep scanning as long as the scan button is pressed.
Default is YES.
- hardwareTriggerEnabled
@property (nonatomic, assign, getter=isHardwareTriggerEnabled)
BOOLhardwareTriggerEnabledAdded in version 6.16.0
Sets whether the SDCSparkScanView should react to clicks of the volume button. Disabled by default.
- visualFeedbackEnabled
@property (nonatomic, assign, getter=isVisualFeedbackEnabled)
BOOLvisualFeedbackEnabledAdded in version 6.16.0
Indicates whether the visual feedback on scan should be displayed.
Default is YES.
- toastSettings
@property (nonatomic, strong) SDCSparkScanToastSettings *toastSettings
Added in version 6.18.0
Sets the toast settings. See SDCSparkScanToastSettings for details.
- JSONString
@property (nonatomic, nonnull, readonly) NSString *JSONString
Added in version 6.16.0
Returns the JSON representation of the spark scan settings.
- zoomFactorOut
@property (nonatomic, assign) CGFloat zoomFactorOut
Added in version 6.23.0
The zoom factor to use for the camera.
Default is 1.
- zoomFactorIn
@property (nonatomic, assign) CGFloat zoomFactorIn
Added in version 6.23.0
The zoom factor to move to when the zoom switch control was tapped.
Default is 2.
- defaultMiniPreviewSize
@property (nonatomic, assign) SDCSparkScanMiniPreviewSize defaultMiniPreviewSize
Added in version 7.0.0
Sets the default size of the mini preview.
Default is SDCSparkScanMiniPreviewSizeRegular.
- defaultCameraPosition
@property (nonatomic, assign) SDCCameraPosition defaultCameraPosition
Added in version 6.24.0
Sets the default camera position.
Default is SDCCameraPositionWorldFacing.
Note
This API is still in beta and may change in future versions of Scandit Data Capture SDK.
- periscopeModeEnabled
@property (nonatomic, assign, getter=isPeriscopeModeEnabled)
BOOLperiscopeModeEnabledAdded in version 7.1.0
Controls the mirroring of the camera feed to support the use of a periscope device.
Default is NO.