SparkScan

Defined in framework ScanditBarcodeCapture

SparkScan

open class SparkScan : NSObject

Added in version 6.8.0

Capture mode that implements SparkScan.

This capture mode uses the barcode scanning capability. It cannot be used together with other capture modes that require the same capabilities, e.g. BarcodeCapture.

init

convenience init()

Added in version 6.16.0

Construct a new SparkScan mode with default settings.

init

init(settings: SparkScanSettings)

Added in version 6.16.0

Construct a new SparkScan mode with the provided settings.

init

convenience init(jsonString JSONString: String) throws

Added in version 6.16.0

Construct a new SparkScan mode from the provided json. Check SparkScanDeserializer for more info.

isEnabled

open var isEnabled: Bool { get, set }

Added in version 6.8.0

This flag indicates whether the SparkScan mode is currently processing frames to recognise barcodes.

Changing this property from false to true causes the connected SparkScanView to start its scanning flow.

Changing this property from true to false causes the connected SparkScanView to stop its scanning flow and go to idle mode.

apply

open func apply(_ settings: SparkScanSettings, completionHandler: (@Sendable () -> Void)? = nil) -> Void

Added in version 6.8.0

Asynchronously applies the new settings to the barcode scanner. If the scanner is currently running, the task will complete when the next frame is processed, and will use the new settings for that frame. If the scanner is currently not running, the task will complete as soon as the settings have been stored and won’t wait until the next frame is going to be processed.

apply

open func apply(_ settings: SparkScanSettings) async -> Void

Added in version 6.8.0

Asynchronously applies the new settings to the barcode scanner. If the scanner is currently running, the task will complete when the next frame is processed, and will use the new settings for that frame. If the scanner is currently not running, the task will complete as soon as the settings have been stored and won’t wait until the next frame is going to be processed.

context

open var context: DataCaptureContext? { get }

Added in version 6.8.0

The context this mode is attached to. When the data capture mode is not attached to a context, null is returned.

addListener

open func addListener(_ listener: any SparkScanListener) -> Void

Added in version 6.8.0

Adds the listener to this SparkScan instance.

In case the same listener is already observing this instance, calling this method will not add the listener again.

removeListener

open func removeListener(_ listener: any SparkScanListener) -> Void

Added in version 6.8.0

Removes a previously added listener from this SparkScan instance.

In case the listener is not currently observing this instance, calling this method has no effect.

sparkScanLicenseInfo

open var sparkScanLicenseInfo: SparkScanLicenseInfo? { get }

Added in version 6.12.0

The object containing information about SparkScan licensing.

Note

This value is available with a small delay. To make sure it is available, set a DataCaptureContextListener and, as soon as DataCaptureContextListener.context() is called, this license object is available.