Barcode Selection

Defined in framework ScanditBarcodeCapture

SDCBarcodeSelection

@interface SDCBarcodeSelection : NSObject <SDCDataCaptureMode>

Added in version 6.6.0

Data capture mode that implements barcode selection.

Learn more on how to use Barcode Selection in our Get Started guide.

This capture mode uses the barcode scanning and tracking capabilities. It cannot be used together with other capture modes that require the same capabilities, e.g. SDCBarcodeCapture.

+ barcodeSelectionWithContext:settings:

+ (instancetype)barcodeSelectionWithContext:(nullable SDCDataCaptureContext *)context
                                   settings:(nonnull SDCBarcodeSelectionSettings *)settings

Added in version 6.6.0

Constructs a new barcode selection mode with the provided context and settings. When the context is not nil, the capture mode is automatically added to the context.

+ barcodeSelectionFromJSONString:context:error:

+ (nullable instancetype)barcodeSelectionFromJSONString:(nonnull NSString *)JSONString
                                                context:(nonnull SDCDataCaptureContext *)context
                                                  error:(NSError **)error

Added in version 6.10.0

Construct a new barcode selection mode with the provided JSON serialization. The capture mode is automatically added to the context.

enabled

@property (nonatomic, assign, getter=isEnabled) BOOL enabled

Added in version 6.6.0

Implemented from SDCDataCaptureMode. See SDCDataCaptureMode.enabled.

feedback

@property (nonatomic, strong, nonnull) SDCBarcodeSelectionFeedback *feedback

Added in version 6.6.0

Instance of SDCBarcodeSelectionFeedback that is used by barcode selection to notify users about the selection of a barcode.

The default instance of the Feedback will have the sound enabled but no vibration. A default click tone will be used for the sound.

To change the feedback emitted, the SDCBarcodeSelectionFeedback can be modified as shown below, or a new one can be assigned.

let barcodeSelection: BarcodeSelection = ...
barcodeSelection.feedback.selection = Feedback(vibration: nil, sound: Sound.default)

context

@property (nonatomic, nullable, readonly) SDCDataCaptureContext *context

Added in version 6.6.0

Implemented from SDCDataCaptureMode. See SDCDataCaptureMode.context.

pointOfInterest

@property (nonatomic, assign) SDCPointWithUnit pointOfInterest

Added in version 6.6.0

The point of interest overwriting the point of interest of the data capture view. By default, this overwriting point of interest is not set and the one from the data capture view is used.

Use SDCPointWithUnitNull (FloatWithUnit.null in Swift) to unset the point of interest.

- applySettings:completionHandler:

- (void)applySettings:(nonnull SDCBarcodeSelectionSettings *)settings
    completionHandler:(nullable void (^)(void))completionHandler

Added in version 6.6.0

Asynchronously applies the new settings to the barcode selection. If the barcode selection is currently running, the task will complete when the next frame is processed, and will use the new settings for that frame. If the barcode selection 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.

recommendedCameraSettings

@property (class, nonatomic, nonnull, readonly) SDCCameraSettings *recommendedCameraSettings

Added in version 6.6.0

Returns the recommended camera settings for use with barcode selection.

- addListener:

- (void)addListener:(nonnull id<SDCBarcodeSelectionListener>)listener

Added in version 6.6.0

Adds the listener to this barcode selection instance.

In case the same listener is already observing this instance, calling this method will not add the listener again. The listener is stored using a weak reference and must thus be retained by the caller for it to not go out of scope.

- removeListener:

- (void)removeListener:(nonnull id<SDCBarcodeSelectionListener>)listener

Added in version 6.6.0

Removes a previously added listener from this barcode selection instance.

In case the listener is not currently observing this instance, calling this method has no effect.

- reset

- (void)reset

Added in version 6.6.0

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

- unfreezeCamera

- (void)unfreezeCamera

Added in version 6.6.0

Unfreeze the camera.

- freezeCamera

- (void)freezeCamera

Added in version 6.12.0

Freeze the camera.

- selectUnselectedBarcodes

- (void)selectUnselectedBarcodes

Added in version 6.12.0

Select all the unselected barcodes that are being tracked in current the barcode selection session. This action is dispatched asynchronously and may happen on the next frame.

- selectAimedBarcode

- (void)selectAimedBarcode

Added in version 6.16.0

Select the barcode being aimed at. Only use this with manual aimer selection.

- unselectBarcodes:

- (void)unselectBarcodes:(NSArray<SDCBarcode *> *)barcodes

Added in version 6.17.0

Remove the barcodes from the list of selected barcodes.

- unselectBarcodesFromJsonString:

- (void)unselectBarcodesFromJsonString:(NSString *)json

Added in version 6.17.0

Remove the barcodes contained in the given JSON string from the list of selected barcodes. The parameter json must be the JSON serialization of an object containing the barcodes inside an array named barcodes. For example:

{
  "barcodes": [
    {
        "data":"9783598215056",
        "rawData":"OTc4MzU5ODIxNTA1Ng==",
        "symbolCount":12,
        "symbology":"ean13Upca"
    }
  ]
}

- increaseCountForBarcodes:

- (void)increaseCountForBarcodes:(NSArray<SDCBarcode *> *)barcodes

Added in version 6.17.0

Increments the count of how many times the given barcodes have been selected.

- increaseCountForBarcodesFromJsonString:

- (void)increaseCountForBarcodesFromJsonString:(NSString *)json

Added in version 6.17.0

Increments the count of how many times the given barcodes have been selected. The parameter json must be the JSON serialization of an object containing the barcodes inside an array named barcodes. For example:

{
  "barcodes": [
    {
        "data":"9783598215056",
        "rawData":"OTc4MzU5ODIxNTA1Ng==",
        "symbolCount":12,
        "symbology":"ean13Upca"
    }
  ]
}

- setSelectBarcode:enabled:

- (void)setSelectBarcode:(nonnull SDCBarcode *)barcode
                 enabled:(BOOL)enabled

Added in version 6.17.0

Enables or disables the selection of a barcode.

- setSelectBarcodeFromJsonString:enabled:

- (void)setSelectBarcodeFromJsonString:(nonnull NSString *)jsonString
                               enabled:(BOOL)enabled

Added in version 6.17.0

Enables or disables the selection of the barcode represented by the given JSON string.

- updateFromJSONString:error:

- (BOOL)updateFromJSONString:(nonnull NSString *)JSONString
                       error:(NSError **)error

Added in version 6.10.0

Updates the mode according to a JSON serialization.

barcodeSelectionLicenseInfo

@property (nonatomic, nullable, readonly) SDCBarcodeSelectionLicenseInfo *barcodeSelectionLicenseInfo

Added in version 6.12.0

The object containing information about barcode selection licensing.

Note

This value is available with a small delay. To make sure it is available, set a SDCDataCaptureContextListener and, as soon as SDCDataCaptureContextListener.context:didAddMode: is called, this license object is available.