Barcode Find

Defined in framework ScanditBarcodeCapture

SDCBarcodeFind

@interface SDCBarcodeFind : NSObject

Added in version 6.18.0

Capture mode that implements BarcodeFind.

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.

- initWithSettings:

- (instancetype)initWithSettings:(nonnull SDCBarcodeFindSettings *)settings

Added in version 6.18.0

Construct a new BarcodeFind mode with the provided settings.

recommendedCameraSettings

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

Added in version 6.18.0

Returns the recommended camera settings for use with barcode find.

enabled

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

Added in version 6.18.0

This flag indicates whether the BarcodeFind mode is currently processing frames to recognise barcodes.

Changing this property from NO to YES causes the connected SDCBarcodeFindView to start its scanning flow.

Changing this property from YES to NO causes the connected SDCBarcodeFindView to stop its scanning flow and go to idle mode.

- applySettings:completionHandler:

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

Added in version 6.18.0

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

context

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

Added in version 6.18.0

The context this mode is attached to. When the data capture mode is not attached to a context, nil is returned.

- addListener:

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

Added in version 6.18.0

Adds the listener to this BarcodeFind 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<SDCBarcodeFindListener>)listener

Added in version 6.18.0

Removes a previously added listener from this BarcodeFind instance.

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

- setItemList:

- (void)setItemList:(nonnull NSSet<SDCBarcodeFindItem *> *)items

Added in version 6.18.0

Sets the list of items to search. This method runs asynchronously.

- start

- (void)start

Added in version 6.18.0

Starts or resumes the search process.

- pause

- (void)pause

Added in version 6.18.0

Pauses the search process.

- stop

- (void)stop

Added in version 6.18.0

Stops the search process and clears the list of found items. If this is not called, the BarcodeFind instance will remember all found items.

feedback

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

Added in version 6.18.0

Instance of SDCBarcodeFindFeedback that is used by the barcode scanner to notify users about Found events.

The default instance of the Feedback will have both sound and vibration enabled. A default beep sound will be used for the sound.

- setBarcodeTransformer:

- (void)setBarcodeTransformer:(id<SDCBarcodeFindTransformer>)barcodeTransformer

Added in version 6.21.0

Sets a transformer for this instance of BarcodeFind.