Barcode AR View

Defined in framework ScanditBarcodeCapture

BarcodeArViewUIDelegate

protocol BarcodeArViewUIDelegate : NSObjectProtocol

Added in version 7.1.0

barcodeAr

optional func barcodeAr(_ barcodeAr: BarcodeAr, didTapHighlightFor barcode: Barcode, highlight: any UIView & BarcodeArHighlight) -> Void

Added in version 7.1.0

Callback method that is called when a barcode highlight is tapped in the view.

BarcodeArView

open class BarcodeArView : UIView

Added in version 7.1.0

Barcode AR comes with a ready-to-use UI that allows highlighting barcodes and displaying additional information over them. The BarcodeArView integrates with any app in just a few lines of code.

init

init(parentView: UIView, barcodeAr: BarcodeAr, settings: BarcodeArViewSettings, cameraSettings: CameraSettings?)

Added in version 7.1.0

Creates a new BarcodeArView with the provided mode, viewSettings and cameraSettings.

uiDelegate

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

Added in version 7.1.0

Sets the listener which is called whenever a barcode highlight is tapped in the view.

highlightProvider

open weak var highlightProvider: BarcodeArHighlightProvider? { get, set }

Added in version 7.1.0

Sets the provider which supplies highlight information for barcodes in the view. If null, a default provider is used, which returns a predefined highlight for each barcode.

annotationProvider

open weak var annotationProvider: BarcodeArAnnotationProvider? { get, set }

Added in version 7.1.0

Sets the provider which supplies annotation information for barcodes in the view. If null, no annotation will be displayed for any barcode.

shouldShowTorchControl

open var shouldShowTorchControl: Bool { get, set }

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

Updates the position of the torch control button.

Default is Anchor.topLeft.

torchControlOffset

open var torchControlOffset: PointWithUnit { get, set }

Added in version 7.3.0

Sets the visual offset of the torch control button.

Use SDCPointWithUnitNull (FloatWithUnit.null in Swift) to unset the value. Default is SDCPointWithUnitNull.

shouldShowZoomControl

open var shouldShowZoomControl: Bool { get, set }

Added in version 7.1.0

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

zoomControlPosition

open var zoomControlPosition: Anchor { get, set }

Added in version 7.1.0

Updates the position of the zoom control button.

Default is Anchor.bottomRight.

zoomControlOffset

open var zoomControlOffset: PointWithUnit { get, set }

Added in version 7.3.0

Sets the visual offset of the zoom control button.

Use SDCPointWithUnitNull (FloatWithUnit.null in Swift) to unset the value. Default is SDCPointWithUnitNull.

shouldShowCameraSwitchControl

open var shouldShowCameraSwitchControl: Bool { get, set }

Added in version 7.1.0

Indicates whether the camera switch control button should be shown to the user.

cameraSwitchControlPosition

open var cameraSwitchControlPosition: Anchor { get, set }

Added in version 7.1.0

Updates the position of the camera switch control button.

Default is Anchor.topRight.

cameraSwitchControlOffset

open var cameraSwitchControlOffset: PointWithUnit { get, set }

Added in version 7.3.0

Sets the visual offset of the camera switch control button.

Use SDCPointWithUnitNull (FloatWithUnit.null in Swift) to unset the value. Default is SDCPointWithUnitNull.

shouldShowMacroModeControl

open var shouldShowMacroModeControl: Bool { get, set }

Added in version 7.1.0

Indicates whether the macro mode control button should be shown to the user.

macroModeControlPosition

open var macroModeControlPosition: Anchor { get, set }

Added in version 7.1.0

Updates the position of the macro mode control button.

Default is Anchor.topRight.

macroModeControlOffset

open var macroModeControlOffset: PointWithUnit { get, set }

Added in version 7.3.0

Sets the visual offset of the macro mode control button.

Use SDCPointWithUnitNull (FloatWithUnit.null in Swift) to unset the value. Default is SDCPointWithUnitNull.

start

open func start() -> Void

Added in version 7.1.0

Starts the scanning process.

stop

open func stop() -> Void

Added in version 7.1.0

Stops the scanning process.

pause

open func pause() -> Void

Added in version 7.1.0

Pauses the scanning process.

reset

open func reset() -> Void

Added in version 7.1.0

Clears all highlights and annotations currently visible and calls highlightProvider and annotationProvider to supply new highlights and annotations.

notificationPresenter

open var notificationPresenter: any NotificationPresenter { get }

Added in version 7.5.0

Returns a NotificationPresenter instance that can be used to present notifications to the user.