Barcode Find View

Defined in framework ScanditBarcodeCapture

BarcodeFindViewUIDelegate

protocol BarcodeFindViewUIDelegate : NSObjectProtocol

Added in version 6.18.0

barcodeFindView

optional func barcodeFindView(_ view: BarcodeFindView, didTapFinishButton foundItems: Set<BarcodeFindItem>) -> Void

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.

BarcodeFindView

open class BarcodeFindView : UIView

Added in version 6.18.0

BarcodeFind 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.

init

init(parentView: UIView, context: DataCaptureContext, barcodeFind: BarcodeFind, settings: BarcodeFindViewSettings)

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)

init

init(parentView: UIView, topLayoutAnchor: NSLayoutYAxisAnchor?, context: DataCaptureContext, barcodeFind: BarcodeFind, settings: BarcodeFindViewSettings, cameraSettings: 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 (null 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

open func prepareSearching() -> Void

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

open func stopSearching() -> Void

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

open func startSearching() -> Void

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

open func pauseSearching() -> Void

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

open weak var uiDelegate: BarcodeFindViewUIDelegate? { get, set }

Added in version 6.18.0

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

shouldShowUserGuidanceView

open var shouldShowUserGuidanceView: Bool { get, set }

Added in version 6.18.0

Indicates whether guidance should be shown to the user.

Default is true.

shouldShowHints

open var shouldShowHints: Bool { get, set }

Added in version 6.18.0

Indicates whether hints should be shown to the user.

Default is true.

shouldShowCarousel

open var shouldShowCarousel: Bool { get, set }

Added in version 6.18.0

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

Default is true.

shouldShowPauseButton

open var shouldShowPauseButton: Bool { get, set }

Added in version 6.18.0

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

Default is true.

shouldShowFinishButton

open var shouldShowFinishButton: Bool { get, set }

Added in version 6.18.0

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

Default is true.

shouldShowProgressBar

open var shouldShowProgressBar: Bool { get, set }

Added in version 6.18.0

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

Default is false.

shouldShowTorchControl

open var shouldShowTorchControl: Bool { get, set }

Added in version 6.20.0

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

Default is false.

torchControlPosition

open var torchControlPosition: Anchor { get, set }

Added in version 6.20.0

Updates the position of the torch control button.

Only Anchor.topLeft, Anchor.topCenter, Anchor.topRight and Anchor.bottomLeft are supported.

Any other value will default to Anchor.topLeft.

shouldShowZoomControl

open var shouldShowZoomControl: Bool { get, set }

Added in version 6.28.0

Indicates whether the zoom control should be shown to the user, allowing them to switch between the normal and ultra-wide lenses.

Default is false.

Note

The zoom control requires a device with an ultra-wide camera. On devices without an ultra-wide camera, setting this property to true has no effect.

textForCollapseCardsButton

open var textForCollapseCardsButton: String? { get, set }

Added in version 6.18.0

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

Default is null.

textForAllItemsFoundSuccessfullyHint

open var textForAllItemsFoundSuccessfullyHint: String? { get, set }

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 null.

textForPointAtBarcodesToSearchHint

open var textForPointAtBarcodesToSearchHint: String? { get, set }

Added in version 6.18.0

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

Default is null.

textForMoveCloserToBarcodesHint

open var textForMoveCloserToBarcodesHint: String? { get, set }

Added in version 6.18.0

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

Default is null.

textForTapShutterToPauseScreenHint

open var textForTapShutterToPauseScreenHint: String? { get, set }

Added in version 6.18.0

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

Default is null.

textForTapShutterToResumeSearchHint

open var textForTapShutterToResumeSearchHint: String? { get, set }

Added in version 6.18.0

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

Default is null.

textForItemListUpdatedHint

open var textForItemListUpdatedHint: String? { get, set }

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 null.

textForItemListUpdatedWhenPausedHint

open var textForItemListUpdatedWhenPausedHint: String? { get, set }

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 null.

set

open func set(value: Any, forProperty property: String) -> Void

Added in version 7.4.2

Sets a custom property on this barcode find view. This function is for internal use. Any features and functionality offered through this method can and will vanish without public notice from one version to the next.