Barcode Find View

Defined in framework ScanditBarcodeCapture

SDCBarcodeFindViewUIDelegate

@protocol SDCBarcodeFindViewUIDelegate <NSObject>

Added in version 6.18.0

- barcodeFindView:didTapFinishButton:

- (void)barcodeFindView:(nonnull SDCBarcodeFindView *)view
     didTapFinishButton:(NSSet<SDCBarcodeFindItem *> *)foundItems

Added in version 6.18.0

Callback method that can be used to define an action that should be performed when the finish button is tapped from the view. The foundItems parameter contains all the items found since the start of the searching process. Called from the main thread.

SDCBarcodeFindView

@interface SDCBarcodeFindView : UIView

Added in version 6.18.0

SDCBarcodeFind comes with a ready-to-use search UI that uses augmented reality overlays to highlight items that match predefined criteria. The BarcodeFindView integrates with any app in just a few lines of code.

- initWithParentView:context:barcodeFind:settings:

- (instancetype)initWithParentView:(nonnull UIView *)parentView
                           context:(nonnull SDCDataCaptureContext *)context
                       barcodeFind:(nonnull SDCBarcodeFind *)barcodeFind
                          settings:(nonnull SDCBarcodeFindViewSettings *)settings

Added in version 6.18.0

Constructs a new BarcodeFind view and adds it to the provided parentView. The provided settings will be used to set the default behaviour and look of the view.

barcodeFindView = BarcodeFindView(parentView: view, // For example the view controller's view property.
                                     context: context,
                                 barcodeFind: barcodeFind,
                                    settings: viewSettings)

- initWithParentView:topLayoutAnchor:context:barcodeFind:settings:cameraSettings:

- (instancetype)initWithParentView:(nonnull UIView *)parentView
                   topLayoutAnchor:(nullable NSLayoutYAxisAnchor *)topLayoutAnchor
                           context:(nonnull SDCDataCaptureContext *)context
                       barcodeFind:(nonnull SDCBarcodeFind *)barcodeFind
                          settings:(nonnull SDCBarcodeFindViewSettings *)settings
                    cameraSettings:(nullable SDCCameraSettings *)cameraSettings

Added in version 6.18.0

Constructs a new BarcodeFind view and adds it to the provided parentView.

The provided settings will be used to set the default behaviour and look of the view.

If camera settings are not provided (nil is passed as an argument) the recommended camera settings for Barcode Find will be used. If camera settings are provided these will be used instead.

The topLayoutAnchor parameter specifies the top vertical anchor the BarcodeFind view should use to arrange its UI elements. The camera feed preview is not affected by this parameter. It can be used, for example, if you have a custom translucent navigation header and want the camera feed to show underneath, but don’t want the header to overlap other BarcodeFind UI elements (such as the progress bar). The default value is self.safeAreaLayoutGuide.topAnchor.

- prepareSearching

- (void)prepareSearching

Added in version 6.18.0

Method to call for preparing the mode for searching. For instance, it can be called when the view controller containing BarcodeFindView is presented (i.e., UIViewController’s viewWillAppear).

- stopSearching

- (void)stopSearching

Added in version 6.18.0

Method to call for stopping the mode. For instance, it can be called when the view controller containing BarcodeFindView is about to disappear (i.e., UIViewController’s viewWillDisappear).

- startSearching

- (void)startSearching

Added in version 6.18.0

Starts the searching process. You can call this method if you want to trigger the searching process without any user interaction.

- pauseSearching

- (void)pauseSearching

Added in version 6.18.0

Pauses the searching process. You can call this method if you want to trigger pausing the searching process without any user interaction.

UIDelegate

@property (nonatomic, weak, nullable) id<SDCBarcodeFindViewUIDelegate> UIDelegate

Added in version 6.18.0

Sets the delegate which is called whenever the finish button is tapped from the view.

shouldShowUserGuidanceView

@property (nonatomic, assign, readwrite) BOOL shouldShowUserGuidanceView

Added in version 6.18.0

Indicates whether guidance should be shown to the user.

Default is YES.

shouldShowHints

@property (nonatomic, assign, readwrite) BOOL shouldShowHints

Added in version 6.18.0

Indicates whether hints should be shown to the user.

Default is YES.

shouldShowCarousel

@property (nonatomic, assign, readwrite) BOOL shouldShowCarousel

Added in version 6.18.0

Indicates whether the item carousel should be shown to the user.

Default is YES.

shouldShowPauseButton

@property (nonatomic, assign, readwrite) BOOL shouldShowPauseButton

Added in version 6.18.0

Indicates whether the pause button should be shown to the user.

Default is YES.

shouldShowFinishButton

@property (nonatomic, assign, readwrite) BOOL shouldShowFinishButton

Added in version 6.18.0

Indicates whether the finish button should be shown to the user.

Default is YES.

shouldShowProgressBar

@property (nonatomic, assign, readwrite) BOOL shouldShowProgressBar

Added in version 6.18.0

Indicates whether the progress bar should be shown to the user.

Default is NO.

shouldShowTorchControl

@property (nonatomic, assign, readwrite) BOOL shouldShowTorchControl

Added in version 6.20.0

Indicates whether the torch control button should be shown to the user.

Default is NO.

torchControlPosition

@property (nonatomic, assign, readwrite) SDCAnchor torchControlPosition

Added in version 6.20.0

Updates the position of the torch control button.

Only SDCAnchorTopLeft, SDCAnchorTopCenter, SDCAnchorTopRight and SDCAnchorBottomLeft are supported.

Any other value will default to SDCAnchorTopLeft.

textForCollapseCardsButton

@property (nonatomic, copy, nullable, readwrite) NSString *textForCollapseCardsButton

Added in version 6.18.0

Overrides the default text displayed in the button for collapsing the item carousel.

Default is nil.

textForAllItemsFoundSuccessfullyHint

@property (nonatomic, copy, nullable, readwrite) NSString *textForAllItemsFoundSuccessfullyHint

Added in version 6.18.0

Overrides the default text displayed in the green confirmation view shown when all items have been found.

Default is nil.

textForPointAtBarcodesToSearchHint

@property (nonatomic, copy, nullable, readwrite) NSString *textForPointAtBarcodesToSearchHint

Added in version 6.18.0

Overrides the default text for the “Point at barcodes to search” hint.

Default is nil.

textForMoveCloserToBarcodesHint

@property (nonatomic, copy, nullable, readwrite) NSString *textForMoveCloserToBarcodesHint

Added in version 6.18.0

Overrides the default text for the “Move closer” hint.

Default is nil.

textForTapShutterToPauseScreenHint

@property (nonatomic, copy, nullable, readwrite) NSString *textForTapShutterToPauseScreenHint

Added in version 6.18.0

Overrides the default text for “Tap shutter to pause” hint.

Default is nil.

textForTapShutterToResumeSearchHint

@property (nonatomic, copy, nullable, readwrite) NSString *textForTapShutterToResumeSearchHint

Added in version 6.18.0

Overrides the default text for “Tap shutter to resume” hint.

Default is nil.

textForItemListUpdatedHint

@property (nonatomic, copy, nullable, readwrite) NSString *textForItemListUpdatedHint

Added in version 6.24.0

Overrides the default text displayed in the confirmation view shown when the item list has been updated.

Default is nil.

textForItemListUpdatedWhenPausedHint

@property (nonatomic, copy, nullable, readwrite) NSString *textForItemListUpdatedWhenPausedHint

Added in version 6.24.0

Overrides the default text displayed in the confirmation view shown when the item list has been updated and search is paused.

Default is nil.