SparkScan Session
Defined under the namespace Scandit.Datacapture.Barcode.Spark
- SparkScanSession
class SparkScanSessionAdded in version 6.24.0
The SparkScan 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 SparkScanSettings.codeDuplicateFilter.
When the SparkScan mode is disabled, the session’s duplicate filter is reset.
Important
The SparkScan 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.
- newlyRecognizedBarcodes
newlyRecognizedBarcodes: Barcode[]
Added in version 6.24.0
List of codes that were newly recognized in the last processed frame.
Deprecated since version 6.26.0: Prefer use of newlyRecognizedBarcode instead.
- newlyRecognizedBarcode
newlyRecognizedBarcode: Barcode | null
Added in version 6.26.0
Last newly recognized barcode in the last processed frame.
- frameSequenceID
frameSequenceID: number
Added in version 6.24.0
The identifier of the current frame sequence.
Important
As long as there is no interruption of frames coming from the camera, the frameSequenceID will stay the same. Note that every time target mode is switched on or off, this number will change.