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

Deprecated since version 6.23.0: Replaced by inactiveStateTimeout.

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

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.

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

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

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

targetZoomFactorOut

@property (nonatomic, assign) CGFloat targetZoomFactorOut

Added in version 6.18.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 SDCSparkScanScanningModeDefault scanning mode.

targetZoomFactorIn

@property (nonatomic, assign) CGFloat targetZoomFactorIn

Added in version 6.18.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 SDCSparkScanScanningModeDefault scanning mode.

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.