Barcode Ar View

Defined in framework ScanditBarcodeCapture

SDCBarcodeArViewUIDelegate

@protocol SDCBarcodeArViewUIDelegate <NSObject>

Added in version 7.1.0

- barcodeAr:didTapHighlightForBarcode:highlight:

- (void)barcodeAr:(SDCBarcodeAr *)barcodeAr
didTapHighlightForBarcode:(SDCBarcode *)barcode
        highlight:(UIView<SDCBarcodeArHighlight> *)highlight

Added in version 7.1.0

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

SDCBarcodeArView

@interface SDCBarcodeArView : UIView

Added in version 7.1.0

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

- initWithParentView:barcodeAr:settings:cameraSettings:

- (instancetype)initWithParentView:(nonnull UIView *)parentView
                         barcodeAr:(nonnull SDCBarcodeAr *)barcodeAr
                          settings:(nonnull SDCBarcodeArViewSettings *)settings
                    cameraSettings:(nullable SDCCameraSettings *)cameraSettings

Added in version 7.1.0

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

UIDelegate

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

Added in version 7.1.0

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

highlightProvider

@property (nonatomic, weak, nullable) id<SDCBarcodeArHighlightProvider> highlightProvider

Added in version 7.1.0

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

annotationProvider

@property (nonatomic, weak, nullable) id<SDCBarcodeArAnnotationProvider> annotationProvider

Added in version 7.1.0

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

shouldShowTorchControl

@property (nonatomic, assign, readwrite) BOOL shouldShowTorchControl

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

Updates the position of the torch control button.

Default is SDCAnchorTopLeft.

torchControlOffset

@property (nonatomic, assign, readwrite) SDCPointWithUnit torchControlOffset

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

@property (nonatomic, assign, readwrite) BOOL shouldShowZoomControl

Added in version 7.1.0

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

zoomControlPosition

@property (nonatomic, assign, readwrite) SDCAnchor zoomControlPosition

Added in version 7.1.0

Updates the position of the zoom control button.

Default is SDCAnchorBottomRight.

zoomControlOffset

@property (nonatomic, assign, readwrite) SDCPointWithUnit zoomControlOffset

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

@property (nonatomic, assign, readwrite) BOOL shouldShowCameraSwitchControl

Added in version 7.1.0

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

cameraSwitchControlPosition

@property (nonatomic, assign, readwrite) SDCAnchor cameraSwitchControlPosition

Added in version 7.1.0

Updates the position of the camera switch control button.

Default is SDCAnchorTopRight.

cameraSwitchControlOffset

@property (nonatomic, assign, readwrite) SDCPointWithUnit cameraSwitchControlOffset

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

@property (nonatomic, assign, readwrite) BOOL shouldShowMacroModeControl

Added in version 7.1.0

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

macroModeControlPosition

@property (nonatomic, assign, readwrite) SDCAnchor macroModeControlPosition

Added in version 7.1.0

Updates the position of the macro mode control button.

Default is SDCAnchorTopRight.

macroModeControlOffset

@property (nonatomic, assign, readwrite) SDCPointWithUnit macroModeControlOffset

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

- (void)start

Added in version 7.1.0

Starts the scanning process.

- stop

- (void)stop

Added in version 7.1.0

Stops the scanning process.

- pause

- (void)pause

Added in version 7.1.0

Pauses the scanning process.

- reset

- (void)reset

Added in version 7.1.0

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