Barcode Selection Session#

Defined in framework ScanditBarcodeCapture

SDCBarcodeSelectionSession#
@interface SDCBarcodeSelectionSession : NSObject

Added in version 6.6.0

Holds the ongoing state of a running SDCBarcodeSelection. An instance of this class is passed to SDCBarcodeSelectionListener.barcodeSelection:didUpdateSelection:frameData: when new barcodes are selected or currently selected barcodes are unselected.

Important

The barcode selection session should only be accessed from within barcodeSelection:didUpdateSelection:frameData: 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 barcodeSelection:didUpdateSelection:frameData:. 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#
@property (nonatomic, nonnull, readonly) NSArray<SDCBarcode *> *newlySelectedBarcodes

Added in version 6.6.0

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

newlyUnselectedBarcodes#
@property (nonatomic, nonnull, readonly) NSArray<SDCBarcode *> *newlyUnselectedBarcodes

Added in version 6.6.0

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

selectedBarcodes#
@property (nonatomic, nonnull, readonly) NSArray<SDCBarcode *> *selectedBarcodes

Added in version 6.6.0

List of currently selected codes.

- selectUnselectedBarcodes#
- (void)selectUnselectedBarcodes

Added in version 6.12.0

Select all the unselected barcodes that are currently being tracked in this barcode selection session.

- reset#
- (void)reset

Added in version 6.6.0

Resets the barcode selection session, effectively clearing the history of selected codes.

- countForBarcode:#
- (NSInteger)countForBarcode:(nonnull SDCBarcode *)barcode

Added in version 6.6.0

Returns how many times the given SDCBarcode was selected.

frameSequenceId#
@property (nonatomic, readonly) NSInteger frameSequenceId

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

lastProcessedFrameId#
@property (nonatomic, readonly) NSInteger lastProcessedFrameId

Added in version 6.6.0

The identifier of the last processed frame.

JSONString#
@property (nonatomic, nonnull, readonly) NSString *JSONString

Added in version 6.10.0

Returns the JSON representation of the barcode tracking session.