SparkScan

Defined under the namespace Scandit.Datacapture.Barcode.Spark

SparkScan

class SparkScan : DataCaptureMode

Added in version 6.24.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.

forSettings(settings)

static forSettings(settings: SparkScanSettings): SparkScan

Added in version 6.24.0

Construct a new SparkScan mode with the provided settings.

isEnabled()

isEnabled(): boolean

Added in version 6.13.0

Get DataCaptureMode. See DataCaptureMode.isEnabled().

setEnabled(enabled)

setEnabled(enabled: boolean): Promise<void>

Added in version 6.24.0

Set DataCaptureMode. See DataCaptureMode.setEnabled().

applySettings(settings)

applySettings(settings: SparkScanSettings): Promise<void>

Added in version 6.24.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

get context(): DataCaptureContext | null

Added in version 6.24.0

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

addListener(listener)

addListener(listener: SparkScanListener): void

Added in version 6.24.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(listener)

removeListener(listener: SparkScanListener): void

Added in version 6.24.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.