Barcode Batch

Defined in framework ScanditBarcodeCapture

BarcodeBatch

open class BarcodeBatch : NSObject, DataCaptureMode

Added in version 6.0.0

Data capture mode that implements MatrixScan (Barcode Batch).

Learn more on how to use Barcode Batch in our Get Started guide.

init

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

Added in version 7.0.0

Constructs a new Barcode Batch 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 7.0.0

Constructs a new Barcode Batch 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 7.0.0

Implemented from DataCaptureMode. See DataCaptureMode.isEnabled.

apply

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

Added in version 7.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: BarcodeBatchSettings) async -> Void

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

Same as apply() with the second argument set to null.

addListener

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

Added in version 7.0.0

Adds the listener to observe 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 BarcodeBatchListener) -> Void

Added in version 7.0.0

Removes a previously added listener from this Barcode Batch 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 7.0.0

Returns the recommended camera settings for use with Barcode Batch.

context

open var context: DataCaptureContext? { get }

Added in version 7.0.0

Implemented from DataCaptureMode. See DataCaptureMode.context.

update

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

Added in version 7.0.0

Updates the mode according to a JSON serialization.

barcodeBatchLicenseInfo

open var barcodeBatchLicenseInfo: BarcodeBatchLicenseInfo? { get }

Added in version 7.0.0

The object containing information about Barcode Batch 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.