Spark Capture Session#

Defined under the namespace Scandit.Datacapture.Barcode.Spark


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

class SparkCaptureSession

Added in version 6.9.0

The spark capture session is responsible for determining the list of relevant barcodes by filtering out duplicates. This filtering of duplicates is completely time-based and does not use any information about the location of the barcode. By default, all the codes scanned in a frame are always reported. It is possible to filter out codes recently scanned by changing SparkCaptureSettings.codeDuplicateFilter.

When the spark capture mode is disabled, the session’s duplicate filter is reset.


The spark capture session should only be accessed from within didScan() or didUpdateSession() and from the thread these methods are called from. It is not safe to be accessed from anywhere else since it may be concurrently modified.

Specifically no reference to newlyRecognizedBarcodes should be kept and traversed outside of didScan() or didUpdateSession(). Instead a copy of the lists should be made to avoid concurrent modification. The individual barcodes can be referenced without copying as they are not further modified.

get newlyRecognizedBarcodes(): Barcode[]

Added in version 6.9.0

List of codes that were newly recognized in the last processed frame.

get frameSequenceID(): number

Added in version 6.9.0

The identifier of the current frame sequence.


As long as there is no interruption of frames coming from the camera, the frameSequenceID will stay the same.