Barcode Tracking Basic Overlay

Defined in framework ScanditBarcodeCapture

SDCBarcodeTrackingBasicOverlayStyle

Added in version 6.10.0

The style of the SDCBarcodeTrackingBasicOverlay

SDCBarcodeTrackingBasicOverlayStyleLegacy

Added in version 6.10.0

Legacy style from versions before 6.10.

Deprecated since version 6.26: This style is deprecated and will be removed in the future.

SDCBarcodeTrackingBasicOverlayStyleFrame

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.

SDCBarcodeTrackingBasicOverlayStyleDot

Added in version 6.10.0

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

SDCBarcodeTrackingBasicOverlay

@interface SDCBarcodeTrackingBasicOverlay : NSObject <SDCDataCaptureOverlay>

Added in version 6.0.0

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

To display the augmentations, this overlay must be attached to a SDCDataCaptureView. This may be done either by creating it with overlayWithBarcodeTracking: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 implementing SDCBarcodeTrackingBasicOverlayDelegate or by calling setBrush:forTrackedBarcode:.

For additional information about using this overlay, refer to MatrixScan Get Started guide.

+ overlayWithBarcodeTracking:forDataCaptureView:

+ (instancetype)overlayWithBarcodeTracking:(nonnull SDCBarcodeTracking *)barcodeTracking
                        forDataCaptureView:(nullable SDCDataCaptureView *)view

Added in version 6.0.0

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

+ overlayWithBarcodeTracking:forDataCaptureView:withStyle:

+ (instancetype)overlayWithBarcodeTracking:(nonnull SDCBarcodeTracking *)barcodeTracking
                        forDataCaptureView:(nullable SDCDataCaptureView *)view
                                 withStyle:(SDCBarcodeTrackingBasicOverlayStyle)style

Added in version 6.10.0

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

+ overlayWithBarcodeTracking:

+ (instancetype)overlayWithBarcodeTracking:(nonnull SDCBarcodeTracking *)barcodeTracking

Added in version 6.0.0

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

+ overlayWithBarcodeTracking:withStyle:

+ (instancetype)overlayWithBarcodeTracking:(nonnull SDCBarcodeTracking *)barcodeTracking
                                 withStyle:(SDCBarcodeTrackingBasicOverlayStyle)style

Added in version 6.10.0

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

+ barcodeTrackingBasicOverlayFromJSONString:mode:error:

+ (nullable instancetype)
  barcodeTrackingBasicOverlayFromJSONString:(nonnull NSString *)JSONString
                                       mode:(nonnull SDCBarcodeTracking *)mode
                                      error:(NSError **)error

Added in version 6.0.0

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

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

delegate

@property (nonatomic, weak, nullable) id<SDCBarcodeTrackingBasicOverlayDelegate> delegate

Added in version 6.0.0

The delegate which is called whenever a new TrackedBarcode is newly tracked or newly recognized.

Note

Using this delegate requires the MatrixScan AR add-on.

defaultBrush

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

Added in version 6.4.0

The default brush applied to recognized tracked barcodes.

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

+ defaultBrushForStyle:

+ (nonnull SDCBrush *)defaultBrushForStyle:(SDCBarcodeTrackingBasicOverlayStyle)style

Added in version 6.10.1

Returns the default brush for the given style.

brush

@property (nonatomic, strong, nullable) SDCBrush *brush

Added in version 6.4.0

The brush applied to recognized tracked barcodes if SDCBarcodeTrackingBasicOverlayDelegate is not implemented. By default the value is set to defaultBrush. Setting this brush to nil hides all tracked barcodes, unless setBrush:forTrackedBarcode: is called.

defaultBrush

@property (nonatomic, strong, nullable) SDCBrush *defaultBrush

Added in version 6.0.0

The default brush applied to recognized tracked barcodes. This is the brush used if SDCBarcodeTrackingBasicOverlayDelegate is not implemented. Setting this brush to nil hides all tracked barcodes, unless setBrush:forTrackedBarcode: is called.

Deprecated since version 6.4.0: Replaced by brush.

- setBrush:forTrackedBarcode:

- (void)setBrush:(nullable SDCBrush *)brush
forTrackedBarcode:(nonnull SDCTrackedBarcode *)trackedBarcode

Added in version 6.0.0

The method can be called to change the visualization style of a tracked barcode. This method is thread-safe, it can be called from any thread. If the brush is nil, then no visualization will be drawn for the tracked barcode. Additionally, tapping on the barcode will have no effect - the action defined by SDCBarcodeTrackingBasicOverlayDelegate.barcodeTrackingBasicOverlay:didTapTrackedBarcode: callback will not be performed.

Note

Using this function requires the MatrixScan AR add-on.

- clearTrackedBarcodeBrushes

- (void)clearTrackedBarcodeBrushes

Added in version 6.0.0

Clears all currently displayed visualizations for the tracked barcodes.

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

shouldShowScanAreaGuides

@property (nonatomic, assign) BOOL shouldShowScanAreaGuides

Added in version 6.0.0

When set to YES, this overlay will visualize the active scan area used for BarcodeTracking. 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.

- updateFromJSONString:error:

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

Added in version 6.0.0

Updates the overlay according to a JSON serialization.

style

@property (nonatomic, readonly) SDCBarcodeTrackingBasicOverlayStyle style

Added in version 6.10.0

The overlay style. Defaults to Legacy.

NSStringFromBarcodeTrackingBasicOverlayStyle(overlayStyle)

NSString *_Nonnull NSStringFromBarcodeTrackingBasicOverlayStyle(SDCBarcodeTrackingBasicOverlayStyle overlayStyle)

Added in version 6.10.0

Returns the string representation of the overlay style.

SDCBarcodeTrackingBasicOverlayStyleFromJSONString(JSONString, overlayStyle)

BOOL SDCBarcodeTrackingBasicOverlayStyleFromJSONString(NSString *_Nonnull JSONString, SDCBarcodeTrackingBasicOverlayStyle *_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.