SparkScan View Settings

Defined in framework ScanditBarcodeCapture

SDCSparkScanViewSettings

@interface SDCSparkScanViewSettings : NSObject

Added in version 6.15.0

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 infinite.

continuousCaptureTimeout

@property (nonatomic, assign) NSTimeInterval continuousCaptureTimeout

Added in version 6.15.0

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

Default is 60 seconds.

defaultScanningMode

@property (nonatomic, strong) id<SDCSparkScanScanningMode> defaultScanningMode

Added 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) BOOL soundEnabled

Added in version 6.16.0

Indicates whether the feedback should have sound enabled.

Default is YES.

hapticEnabled

@property (nonatomic, assign, getter=isHapticEnabled) BOOL hapticEnabled

Added 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.

holdToScanEnabled

@property (nonatomic, assign, getter=isHoldToScanEnabled) BOOL holdToScanEnabled

Added 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) BOOL hardwareTriggerEnabled

Added 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) BOOL visualFeedbackEnabled

Added in version 6.16.0

Indicates whether the visual feedback on scan should be displayed.

Default is YES.

JSONString

@property (nonatomic, nonnull, readonly) NSString *JSONString

Added in version 6.16.0

Returns the JSON representation of the spark scan settings.

ignoreDragLimits

@property (nonatomic, assign) BOOL ignoreDragLimits

Added in version 6.17.0

If set to YES 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 NO.

Note

The ignoreDragLimits API is still in beta and may change in future versions of Scandit Data Capture SDK.