Barcode Selection Basic Overlay

Defined in framework ScanditBarcodeCapture

SDCBarcodeSelectionBasicOverlayStyle

Added in version 6.10.0

The style of the SDCBarcodeSelectionBasicOverlay.

SDCBarcodeSelectionBasicOverlayStyleFrame

Added in version 6.10.0

Style that draws the highlights as a rectangular frame and adds an animation for when a code newly appears.

SDCBarcodeSelectionBasicOverlayStyleDot

Added in version 6.10.0

Style that draws the highlights as a dot and adds an animation for when a code newly appears.

SDCBarcodeSelectionBrushProvider

@protocol SDCBarcodeSelectionBrushProvider <NSObject>

Added in version 6.17.0

Protocol for applying custom brushes to recognized barcodes.

- brushForBarcode:

- (nullable SDCBrush *)brushForBarcode:(SDCBarcode *)barcode

Added in version 6.17.0

Return the brush to apply to the given barcode. A non-nil brush returned by this method overrides any other brush set for the barcode.

SDCBarcodeSelectionBasicOverlay

@interface SDCBarcodeSelectionBasicOverlay : UIView <SDCDataCaptureOverlay>

Added in version 6.6.0

An overlay for SDCDataCaptureView that shows a simple augmentation over each selected barcode.

To display the augmentations, this overlay must be attached to a SDCDataCaptureView. This may be done either by creating it with overlayWithBarcodeSelection:forDataCaptureView: with a non-null view parameter or by passing this overlay to SDCDataCaptureView.addOverlay:.

A user of this class may configure the appearance of the augmentations by configuring the brush properties.

+ overlayWithBarcodeSelection:forDataCaptureView:

+ (instancetype)overlayWithBarcodeSelection:(nonnull SDCBarcodeSelection *)barcodeSelection
                         forDataCaptureView:(nullable SDCDataCaptureView *)view

Added in version 6.6.0

Constructs a new barcode selection basic overlay for the barcode selection instance. The overlay is automatically added to the view.

+ overlayWithBarcodeSelection:forDataCaptureView:withStyle:

+ (instancetype)overlayWithBarcodeSelection:(nonnull SDCBarcodeSelection *)barcodeSelection
                         forDataCaptureView:(nullable SDCDataCaptureView *)view
                                  withStyle:(SDCBarcodeSelectionBasicOverlayStyle)style

Added in version 6.10.0

Constructs a new barcode selection basic overlay for the barcode selection instance with the specified style. The overlay is automatically added to the view.

+ overlayWithBarcodeSelection:

+ (instancetype)overlayWithBarcodeSelection:(nonnull SDCBarcodeSelection *)barcodeSelection

Added in version 6.6.0

Constructs a new barcode selection basic overlay for the barcode selection instance. For the overlay to be displayed on screen, it must be added to a SDCDataCaptureView.

+ overlayWithBarcodeSelection:withStyle:

+ (instancetype)overlayWithBarcodeSelection:(nonnull SDCBarcodeSelection *)barcodeSelection
                                  withStyle:(SDCBarcodeSelectionBasicOverlayStyle)style

Added in version 6.10.0

Constructs a new barcode selection basic overlay for the barcode selection instance with the specified style. For the overlay to be displayed on screen, it must be added to a SDCDataCaptureView.

+ barcodeSelectionBasicOverlayFromJSONString:mode:error:

+ (nullable instancetype)
  barcodeSelectionBasicOverlayFromJSONString:(nonnull NSString *)JSONString
                                        mode:(nonnull SDCBarcodeSelection *)mode
                                       error:(NSError **)error

Added in version 6.14.0

Constructs a new barcode selection basic overlay with the provided JSON serialization.

For the overlay to be displayed on screen, it must be added to a SDCDataCaptureView.

defaultTrackedBrush

@property (class, nonatomic, nonnull, readonly) SDCBrush *defaultTrackedBrush

Added in version 6.6.0

The default brush applied to recognized tracked barcodes.

Deprecated since version 6.10.1: The defaultTrackedBrush of the overlay depends on the style used, there is no unique default brush. Use defaultTrackedBrushForStyle: instead.

+ defaultTrackedBrushForStyle:

+ (nonnull SDCBrush *)defaultTrackedBrushForStyle:(SDCBarcodeSelectionBasicOverlayStyle)style

Added in version 6.10.1

Returns the default tracked brush for the given style.

defaultAimedBrush

@property (class, nonatomic, nonnull, readonly) SDCBrush *defaultAimedBrush

Added in version 6.6.0

The default brush applied to aimed barcodes.

Deprecated since version 6.10.1: The defaultAimedBrush of the overlay depends on the style used, there is no unique default brush. Use defaultAimedBrushForStyle: instead.

+ defaultAimedBrushForStyle:

+ (nonnull SDCBrush *)defaultAimedBrushForStyle:(SDCBarcodeSelectionBasicOverlayStyle)style

Added in version 6.10.1

Returns the default aimed brush for the given style.

defaultSelectedBrush

@property (class, nonatomic, nonnull, readonly) SDCBrush *defaultSelectedBrush

Added in version 6.6.0

The default brush applied to selected barcodes.

+ defaultSelectedBrushForStyle:

+ (nonnull SDCBrush *)defaultSelectedBrushForStyle:(SDCBarcodeSelectionBasicOverlayStyle)style

Added in version 6.10.1

Returns the default selected brush for the given style.

defaultSelectingBrush

@property (class, nonatomic, nonnull, readonly) SDCBrush *defaultSelectingBrush

Added in version 6.6.0

The default brush applied to barcodes currently being selected.

+ defaultSelectingBrushForStyle:

+ (nonnull SDCBrush *)defaultSelectingBrushForStyle:(SDCBarcodeSelectionBasicOverlayStyle)style

Added in version 6.10.1

Returns the default selecting brush for the given style.

trackedBrush

@property (nonatomic, strong, nonnull) SDCBrush *trackedBrush

Added in version 6.6.0

The brush applied to recognized tracked barcodes, by default the value is set to defaultTrackedBrush. Setting this brush to SDCBrush.transparentBrush hides all tracked barcodes.

aimedBrush

@property (nonatomic, strong, nonnull) SDCBrush *aimedBrush

Added in version 6.6.0

The brush applied to the barcode that is currently being aimed at.

By default the value is set to defaultAimedBrush.

selectedBrush

@property (nonatomic, strong, nonnull) SDCBrush *selectedBrush

Added in version 6.6.0

The brush applied to selected barcodes, by default the value is set to defaultSelectedBrush. Setting this brush to SDCBrush.transparentBrush hides all selected barcodes.

selectingBrush

@property (nonatomic, strong, nonnull) SDCBrush *selectingBrush

Added in version 6.6.0

The brush applied to the barcodes for the short moment when they are being selected.

By default the value is set to defaultSelectingBrush.

shouldShowScanAreaGuides

@property (nonatomic, assign) BOOL shouldShowScanAreaGuides

Added in version 6.6.0

When set to YES, this overlay will visualize the active scan area used for BarcodeSelection. This is useful to check margins defined on the SDCDataCaptureView are set correctly. This property is meant for debugging during development and is not intended for use in production.

By default this property is NO.

shouldShowHints

@property (nonatomic, assign) BOOL shouldShowHints

Added in version 6.6.0

When set to YES, this overlay will visualize some hints explaining how to use barcode selection.

By default this property is YES.

viewfinder

@property (nonatomic, strong, nonnull, readonly) id<SDCViewfinder> viewfinder

Added in version 6.6.0

The viewfinder of the overlay. The viewfinder is only visible when the selection type is SDCBarcodeSelectionAimerSelection.

- clearSelectedBarcodeBrushes

- (void)clearSelectedBarcodeBrushes

Added in version 6.6.0

Clears all currently displayed visualizations for the on screen barcodes.

This only applies to the currently displayed barcodes, the visualizations for the new ones will still appear.

- setTextForSelectOrDoubleTapToFreezeHint:

- (void)setTextForSelectOrDoubleTapToFreezeHint:(nonnull NSString *)text

Added in version 6.14.0

Sets the text of the hint which suggests to use double tap gesture to freeze capture view.

- setTextForTapToSelectHint:

- (void)setTextForTapToSelectHint:(nonnull NSString *)text

Added in version 6.14.0

Sets the text of the hint which suggests to use tap gesture to select barcodes.

- setTextForDoubleTapToUnfreezeHint:

- (void)setTextForDoubleTapToUnfreezeHint:(nonnull NSString *)text

Added in version 6.14.0

Sets the text of the hint which suggests to use double tap gesture to unfreeze capture view.

- setTextForTapAnywhereToSelectHint:

- (void)setTextForTapAnywhereToSelectHint:(nonnull NSString *)text

Added in version 6.14.0

Sets the text of the hint which suggests to use tap gesture anywhere on the screen to select.

- setTextForAimToSelectAutoHint:

- (void)setTextForAimToSelectAutoHint:(nonnull NSString *)text

Added in version 6.18.0

Sets the text of the hint which suggests to aim at a barcode to scan it.

- setAimedBarcodeBrushProvider:

- (void)setAimedBarcodeBrushProvider:(nullable id<SDCBarcodeSelectionBrushProvider>)brushProvider

Added in version 6.17.0

Sets the brush provider for aimed barcode.

- setTrackedBarcodeBrushProvider:

- (void)setTrackedBarcodeBrushProvider:(nullable id<SDCBarcodeSelectionBrushProvider>)brushProvider

Added in version 6.17.0

Sets the brush provider for tracked barcode.

- updateFromJSONString:error:

- (BOOL)updateFromJSONString:(nonnull NSString *)JSONString
                       error:(NSError **)error

Added in version 6.14.0

Updates the overlay according to a JSON serialization.

frozenBackgroundColor

@property (nonatomic, strong, nonnull) UIColor *frozenBackgroundColor

Added in version 6.12.0

The overlay’s background color when in frozen state. This color will be on top of the video preview but below the highlights. Semitransparent black by default.

style

@property (nonatomic, readonly) SDCBarcodeSelectionBasicOverlayStyle style

Added in version 6.10.0

The overlay style. Defaults to Frame.

NSStringFromBarcodeSelectionBasicOverlayStyle(overlayStyle)

NSString *_Nonnull NSStringFromBarcodeSelectionBasicOverlayStyle(SDCBarcodeSelectionBasicOverlayStyle overlayStyle)

Added in version 6.10.0

Returns the string representation of the overlay style.

SDCBarcodeSelectionBasicOverlayStyleFromJSONString(JSONString, overlayStyle)

BOOL SDCBarcodeSelectionBasicOverlayStyleFromJSONString(NSString *_Nonnull JSONString, SDCBarcodeSelectionBasicOverlayStyle *_Nonnull overlayStyle)

Added in version 6.10.0

Creates the overlay style from its string representation

Deprecated since version 6.26.0: This function will be removed in the future.