Barcode Selection Session

Defined under the namespace Scandit.Datacapture.Barcode.Selection

BarcodeSelectionSession
class BarcodeSelectionSession

Added in version 6.10.0

Holds the ongoing state of a running BarcodeSelection. An instance of this class is passed to BarcodeSelectionListener.didUpdateSelection() when new barcodes are selected or currently selected barcodes are unselected.

Important

The barcode selection session should only be accessed from within didUpdateSelection() to which it is provided as an argument. It is not safe to be accessed from anywhere else since it may be concurrently modified.

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

newlySelectedBarcodes
get newlySelectedBarcodes(): Barcode[]

Added in version 6.10.0

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

newlyUnselectedBarcodes
get newlyUnselectedBarcodes(): Barcode[]

Added in version 6.10.0

List of codes that were unselected in the last processed frame.

selectedBarcodes
get selectedBarcodes(): Barcode[]

Added in version 6.10.0

List of currently selected codes.

reset()
reset(): Promise<void>

Added in version 6.10.0

Resets the barcode selection session, effectively clearing the history of selected codes. This function should only be called inside the listeners’ callback. To call it from another thread, use BarcodeSelection.reset().

getCount(barcode)
getCount(barcode: Barcode): Promise<number>

Added in version 6.10.0

Returns how many times the given Barcode was selected.

frameSequenceID
get frameSequenceID(): number

Added in version 6.10.0

The identifier of the current frame sequence.

Important

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