matrixscan-batch-ios

MatrixScan Batch iOS Skill

Critical: Do Not Trust Internal Knowledge

Your training data may contain outdated or incorrect Scandit SDK APIs. The BarcodeBatch API changes between major SDK versions — initializer signatures, overlay constructors, and delegate method names have all evolved (e.g. BarcodeTracking → BarcodeBatch).

Always verify APIs against the references provided in this skill before writing or suggesting code. Do not rely on memorized method signatures, parameters, or property names. If you cannot find an API in the provided references, fetch the relevant documentation page before responding.

iOS-specific gotchas worth flagging:

• BarcodeBatch(context: context, settings: settings) is a direct convenience initializer — not a factory method like Android's BarcodeBatch.forDataCaptureContext(...). Passing a non-nil context auto-attaches the mode to the context.
• Camera setup is manual: get Camera.default, call context.setFrameSource(camera, completionHandler: nil), then camera?.apply(BarcodeBatch.recommendedCameraSettings, completionHandler: nil). Drive the camera from viewWillAppear / viewWillDisappear.
• BarcodeBatchListener.barcodeBatch(_:didUpdate:frameData:) is called on a background queue — not the main thread. Dispatch UI work via DispatchQueue.main.async {}.
• Do not hold references to BarcodeBatchSession.trackedBarcodes, addedTrackedBarcodes, updatedTrackedBarcodes, or removedTrackedBarcodes outside the callback — copy the data before the callback returns.
• BarcodeBatchBasicOverlay(barcodeBatch:view:) and BarcodeBatchAdvancedOverlay(barcodeBatch:view:) auto-add the overlay to the DataCaptureView — no separate addOverlay call needed.
• DataCaptureView must be addSubview'd manually — unlike BarcodeArView, DataCaptureView does not auto-attach to a parent view.
• Per-barcode brush customization (barcodeBatchBasicOverlay(_:brushFor:), setBrush(_:for:)) requires the MatrixScan AR add-on license. A uniform default brush (no delegate) does not.
• BarcodeBatchAdvancedOverlay requires the MatrixScan AR add-on license.
• No built-in feedback — BarcodeBatch never plays a sound or vibrates on its own (unlike BarcodeCapture / SparkScan). Emit feedback manually with Feedback.default.emit() from inside the listener callback (dispatched to the main thread), gated on session.addedTrackedBarcodes so it doesn't beep every frame.
• session.removedTrackedBarcodes is an [Int] of tracking identifiers (barcodes that left the frame) — not TrackedBarcode objects. addedTrackedBarcodes / updatedTrackedBarcodes are [TrackedBarcode].
• iOS symbology cases are camelCase: .ean13UPCA, .code128, .qr — not EAN13_UPCA / CODE128 / QR like Android.
• iOS delegate methods use Swift naming: barcodeBatchBasicOverlay(_:didTap:) (not Android's onTrackedBarcodeTapped), barcodeBatchAdvancedOverlay(_:viewFor:) (not viewForTrackedBarcode).
• BarcodeBatchAdvancedOverlayDelegate uses UIView — not Android View or SwiftUI views.
• SwiftUI: DataCaptureView is a UIView and cannot be dropped into SwiftUI directly. Wrap a UIKit view controller in a UIViewControllerRepresentable and keep all BarcodeBatch APIs inside that view controller.
• Cleanup: BarcodeBatchListener is held as a weak reference, so a missed removeListener won't leak — but call barcodeBatch.removeListener(self) in deinit to make the lifecycle explicit. When using the shared singleton (DataCaptureContext.shared), modes stay attached for the app's lifetime — you don't need to call removeCurrentMode() or dispose(). Those methods do exist on DataCaptureContext if you want to tear down explicitly.
• DataCaptureContext exposes two valid initializers: DataCaptureContext.initialize(licenseKey:) + .shared (added 7.1.0/7.6.0 — the modern singleton pattern, and what this skill uses) and the older DataCaptureContext(licenseKey:) convenience init (still non-deprecated, and what the UIKit Get Started page on docs.scandit.com still shows). Prefer the singleton form.