Barcode Batch Basic Overlay

Defined in framework ScanditBarcodeCapture

enum BarcodeBatchBasicOverlayStyle

Added in version 7.0.0

The style of the BarcodeBatchBasicOverlay

frame

Added in version 7.0.0

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

dot

Added in version 7.0.0

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

jsonString

open var jsonString: String { get }

Added in version 7.0.0

Returns the string representation of the overlay style.

BarcodeBatchBasicOverlay

open class BarcodeBatchBasicOverlay : NSObject, DataCaptureOverlay

Added in version 7.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 DataCaptureView. This may be done either by creating it with init() with a non-null view parameter or by passing this overlay to DataCaptureView.addOverlay().

A user of this class may configure the appearance of the augmentations by implementing BarcodeBatchBasicOverlayDelegate or by calling setBrush().

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

init

convenience init(barcodeBatch: BarcodeBatch, view: DataCaptureView?)

Added in version 7.0.0

Constructs a new Barcode Batch basic overlay for the Barcode Batch instance. The overlay is automatically added to the view.

init

convenience init(barcodeBatch: BarcodeBatch, view: DataCaptureView?, style: BarcodeBatchBasicOverlayStyle)

Added in version 7.0.0

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

init

convenience init(barcodeBatch: BarcodeBatch)

Added in version 7.0.0

Constructs a new Barcode Batch basic overlay for the Barcode Batch instance. For the overlay to be displayed on screen, it must be added to a DataCaptureView.

init

convenience init(barcodeBatch: BarcodeBatch, with style: BarcodeBatchBasicOverlayStyle)

Added in version 7.0.0

Constructs a new Barcode Batch basic overlay for the Barcode Batch instance with the specified style. For the overlay to be displayed on screen, it must be added to a DataCaptureView.

init

convenience init(jsonString JSONString: String, barcodeBatch mode: BarcodeBatch) throws

Added in version 7.0.0

Constructs a new Barcode Batch basic overlay with the provided JSON serialization.

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

delegate

open weak var delegate: BarcodeBatchBasicOverlayDelegate? { get, set }

Added in version 7.0.0

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

Note

Using this listener requires the MatrixScan AR add-on.

defaultBrush

open class func defaultBrush(forStyle style: BarcodeBatchBasicOverlayStyle) -> Brush

Added in version 7.0.0

Returns the default brush for the given style.

brush

open var brush: Brush? { get, set }

Added in version 7.0.0

The brush applied to recognized tracked barcodes if BarcodeBatchBasicOverlayDelegate is not implemented.

By default the value is set to defaultBrush().

Setting this brush to null hides all tracked barcodes, unless setBrush() is called.

setBrush

open func setBrush(_ brush: Brush?, for trackedBarcode: TrackedBarcode) -> Void

Added in version 7.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 null, then no visualization will be drawn for the tracked barcode. Additionally, tapping on the barcode will have no effect - the action defined by BarcodeBatchBasicOverlayDelegate.barcodeBatchBasicOverlay() callback will not be performed.

Note

Using this function requires the MatrixScan AR add-on.

clearTrackedBarcodeBrushes

open func clearTrackedBarcodeBrushes() -> Void

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

open var shouldShowScanAreaGuides: Bool { get, set }

Added in version 7.0.0

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

By default this property is false.

update

open func update(fromJSONString JSONString: String) throws -> Void

Added in version 7.0.0

Updates the overlay according to a JSON serialization.

style

open var style: BarcodeBatchBasicOverlayStyle { get }

Added in version 7.0.0

The overlay style. Defaults to Frame.