Barcode Capture

Defined in framework ScanditBarcodeCapture

BarcodeCapture

open class BarcodeCapture : NSObject, DataCaptureMode

Added in version 6.0.0

Capture mode for single barcode scanning. This capture mode uses the barcode scanning capability.

Learn more on how to use barcode capture in our Get Started guide.

For MatrixScan-based barcode capture, use BarcodeBatch instead.

It cannot be used together with other capture modes that require the same capabilities, e.g. BarcodeBatch or LabelCapture.

init

convenience init(context: DataCaptureContext?, settings: BarcodeCaptureSettings)

Added in version 6.0.0

Construct a new barcode capture mode with the provided context and settings. When the context is not null, the capture mode is automatically added to the context.

init

convenience init(jsonString JSONString: String, context: DataCaptureContext) throws

Added in version 6.0.0

Construct a new barcode capture mode with the provided JSON serialization. The capture mode is automatically added to the context.

isEnabled

open var isEnabled: Bool { get, set }

Added in version 6.0.0

Implemented from DataCaptureMode. See DataCaptureMode.isEnabled.

pointOfInterest

open var pointOfInterest: PointWithUnit { get, set }

Added in version 6.1.0

The point of interest overwriting the point of interest of the data capture view. By default, this overwriting point of interest is not set and the one from the data capture view is used.

Use SDCPointWithUnitNull (FloatWithUnit.null in Swift) to unset the point of interest.

The overwriting point of interest is used to control the center of attention for the following subsystems:

Location selection. When no location selection is set, the point of interest defines the location at which the recognition optimizes for reading barcodes.
Rendered viewfinders.

apply

open func apply(_ settings: BarcodeCaptureSettings, completionHandler: (@Sendable () -> Void)? = nil) -> Void

Added in version 6.0.0

Asynchronously applies the new settings to the barcode scanner. If the scanner is currently running, the task will complete when the next frame is processed, and will use the new settings for that frame. If the scanner is currently not running, the task will complete as soon as the settings have been stored and won’t wait until the next frame is going to be processed.

apply

open func apply(_ settings: BarcodeCaptureSettings) async -> Void

Added in version 6.0.0

Asynchronously applies the new settings to the barcode scanner. If the scanner is currently running, the task will complete when the next frame is processed, and will use the new settings for that frame. If the scanner is currently not running, the task will complete as soon as the settings have been stored and won’t wait until the next frame is going to be processed.

feedback

open var feedback: BarcodeCaptureFeedback { get, set }

Added in version 6.0.0

Instance of BarcodeCaptureFeedback that is used by the barcode scanner to notify users about Success and Failure events.

The default instance of the Feedback will have both sound and vibration enabled. A default beep sound will be used for the sound.

To change the feedback emitted, the BarcodeCaptureFeedback can be modified as shown below, or a new one can be assigned.

let barcodeCapture: BarcodeCapture = ...
barcodeCapture.feedback.success = Feedback(vibration: nil, sound: Sound.default)

addListener

open func addListener(_ listener: any BarcodeCaptureListener) -> Void

Added in version 6.0.0

Adds the listener to this barcode capture instance.

In case the same listener is already observing this instance, calling this method will not add the listener again.

removeListener

open func removeListener(_ listener: any BarcodeCaptureListener) -> Void

Added in version 6.0.0

Removes a previously added listener from this barcode capture instance.

In case the listener is not currently observing this instance, calling this method has no effect.

recommendedCameraSettings

open class var recommendedCameraSettings: CameraSettings { get }

Added in version 6.1.0

Returns the recommended camera settings for use with barcode capture.

context

open var context: DataCaptureContext? { get }

Added in version 6.0.0

Implemented from DataCaptureMode. See DataCaptureMode.context.

update

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

Added in version 6.0.0

Updates the mode according to a JSON serialization.

barcodeCaptureLicenseInfo

open var barcodeCaptureLicenseInfo: BarcodeCaptureLicenseInfo? { get }

Added in version 6.12.0

The object containing information about barcode capture licensing.

Note

This value is available with a small delay. To make sure it is available, set a DataCaptureContextListener and, as soon as DataCaptureContextListener.context() is called, this license object is available.