Barcode Capture Overlay

Defined in framework ScanditBarcodeCapture

BarcodeCaptureOverlay

open class BarcodeCaptureOverlay : NSObject, DataCaptureOverlay

Added in version 6.0.0

Overlay for the BarcodeCapture capture mode that displays recognized barcodes on top of a data capture view.

The appearance of the visualized barcodes can be configured or turned off completely through the brush property.

init

convenience init(barcodeCapture: BarcodeCapture, view: DataCaptureView?)

Added in version 6.0.0

Constructs a new barcode capture overlay for the provided barcode capture instance. When passing a non-null view instance, the overlay is automatically added to the view.

init

convenience init(jsonString JSONString: String, barcodeCapture mode: BarcodeCapture) throws

Added in version 6.0.0

Constructs a new barcode capture overlay with the provided JSON serialization.

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

init

convenience init(barcodeCapture: BarcodeCapture)

Added in version 6.0.0

Constructs a new barcode capture overlay for the provided barcode capture instance. For the overlay to be displayed on screen, it must be added to a DataCaptureView.

viewfinder

open var viewfinder: (any Viewfinder)? { get, set }

Added in version 6.0.0

Set the viewfinder. By default, the viewfinder is null. Set this to an instance of Viewfinder if you want to draw a viewfinder.

brush

open var brush: Brush { get, set }

Added in version 6.0.0

The brush used for visualizing a recognized barcode in the UI. To turn off drawing of locations, set the brush to use both a transparent fill and stroke color. By default, the brush has a transparent fill color, a “Scandit”-blue stroke color, and a stroke width of 1.

defaultBrush

open class var defaultBrush: Brush { get }

Added in version 7.5.0

Returns the default brush used by the overlay.

shouldShowScanAreaGuides

open var shouldShowScanAreaGuides: Bool { get, set }

Added in version 6.0.0

Whether to show scan area guides on top of the preview. This property is useful during development to visualize the current scan areas on screen. It is not meant to be used for production. By default this property is false.

update

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

Added in version 6.0.0

Updates the overlay according to a JSON serialization.

setValue

open func setValue(_ value: Any?, forProperty property: String) -> Void

Added in version 6.0.0

Set barcode capture overlay property to the provided value. Use this method to set properties that are not yet part of a stable API. Properties set through this method may or may not be used or change in a future release.