matrixscan-batch-ios
MatrixScan Batch (MatrixScan, BarcodeBatch, legacy BarcodeTracking) — tracking and scanning multiple barcodes at once in iOS (Swift, UIKit/SwiftUI) projects. Use for integration, settings and symbolog
SKILL.mdskills/source-950cb276a8a9a3cab63ca45d/SKILL.md
GitHubMatrixScan 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'sBarcodeBatch.forDataCaptureContext(...). Passing a non-nil context auto-attaches the mode to the context.- Camera setup is manual: get
Camera.default, callcontext.setFrameSource(camera, completionHandler: nil), thencamera?.apply(BarcodeBatch.recommendedCameraSettings, completionHandler: nil). Drive the camera fromviewWillAppear/viewWillDisappear. BarcodeBatchListener.barcodeBatch(_:didUpdate:frameData:)is called on a background queue — not the main thread. Dispatch UI work viaDispatchQueue.main.async {}.- Do not hold references to
BarcodeBatchSession.trackedBarcodes,addedTrackedBarcodes,updatedTrackedBarcodes, orremovedTrackedBarcodesoutside the callback — copy the data before the callback returns. BarcodeBatchBasicOverlay(barcodeBatch:view:)andBarcodeBatchAdvancedOverlay(barcodeBatch:view:)auto-add the overlay to theDataCaptureView— no separateaddOverlaycall needed.DataCaptureViewmust beaddSubview'd manually — unlikeBarcodeArView,DataCaptureViewdoes 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 —
BarcodeBatchnever plays a sound or vibrates on its own (unlikeBarcodeCapture/SparkScan). Emit feedback manually withFeedback.default.emit()from inside the listener callback (dispatched to the main thread), gated onsession.addedTrackedBarcodesso it doesn't beep every frame. session.removedTrackedBarcodesis an[Int]of tracking identifiers (barcodes that left the frame) — notTrackedBarcodeobjects.addedTrackedBarcodes/updatedTrackedBarcodesare[TrackedBarcode].- iOS symbology cases are camelCase:
.ean13UPCA,.code128,.qr— notEAN13_UPCA/CODE128/QRlike Android. - iOS delegate methods use Swift naming:
barcodeBatchBasicOverlay(_:didTap:)(not Android'sonTrackedBarcodeTapped),barcodeBatchAdvancedOverlay(_:viewFor:)(notviewForTrackedBarcode). BarcodeBatchAdvancedOverlayDelegateusesUIView— not AndroidViewor SwiftUI views.- SwiftUI:
DataCaptureViewis aUIViewand cannot be dropped into SwiftUI directly. Wrap a UIKit view controller in aUIViewControllerRepresentableand keep all BarcodeBatch APIs inside that view controller. - Cleanup:
BarcodeBatchListeneris held as a weak reference, so a missedremoveListenerwon't leak — but callbarcodeBatch.removeListener(self)indeinitto make the lifecycle explicit. When using the shared singleton (DataCaptureContext.shared), modes stay attached for the app's lifetime — you don't need to callremoveCurrentMode()ordispose(). Those methods do exist onDataCaptureContextif you want to tear down explicitly. DataCaptureContextexposes 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 olderDataCaptureContext(licenseKey:)convenience init (still non-deprecated, and what the UIKit Get Started page on docs.scandit.com still shows). Prefer the singleton form.
Intent Routing
Based on the user's request, load the appropriate reference file before responding:
- Integrating MatrixScan Batch from scratch, configuring settings, handling tracked barcodes, customizing overlays, adding feedback, or managing lifecycle → read references/integration.md and follow the instructions there. Before writing code, determine whether the project uses UIKit or SwiftUI (check for
import SwiftUI, an@mainAppstruct,SceneDelegate/AppDelegate,.storyboard/.xibfiles, etc.) and use the matching Get Started page from the References table below. If the project already has BarcodeBatch wired up, do not re-create the context, mode, view, or lifecycle — locate the existing ones (grep forBarcodeBatch, thenDataCaptureView) and change only what the user asked for. - Upgrading the Scandit SDK version (e.g. v6→v7, v7→v8, or "upgrade to the latest") → read references/migration.md. The headline v6→v7 change for MatrixScan Batch is the
BarcodeTracking→BarcodeBatchrename; the guide also covers the context/camera modernization. Detect the installed version fromPackage.resolved/Podfile.lockbefore asking the user. - Replacing a different barcode scanner with MatrixScan Batch (AVFoundation
AVCaptureMetadataOutput, VisionKitDataScannerViewController, or another third-party multi-barcode SDK) → read references/third-party-migration.md, then follow references/integration.md for the BarcodeBatch integration.
API Usage Policy
Only use APIs that are explicitly documented in the Scandit references below. Do not invent or guess method signatures, parameters, or property names. If unsure whether an API exists or how it is called — or if a compile error occurs — fetch the relevant reference page before responding. Do not tell the user to check the docs themselves. After answering, always include the relevant link so the user can explore further.
Never construct or guess documentation URLs. When you need a specific class or property's API page:
- First check whether the page you already fetched contains a direct hyperlink to it — topic pages link directly to relevant API symbols. Always request links alongside content in your fetch prompt.
- If no direct link was found, fetch the API index (see Full API reference in the table below), extract the actual link from it, and follow that.
URL structures can vary (e.g. api/ui/ subdirectory) and guessing will lead to 404s.
References
| Topic | Resource |
|---|---|
| UIKit integration | Get Started (UIKit) · Sample |
| SwiftUI integration | Get Started (SwiftUI) |
| AR overlays (BasicOverlay brushes, AdvancedOverlay views) | Adding AR Overlays |
| Version migration (v6→v7→v8) | Migrate 6→7 · Migrate 7→8 |
| Full API reference | BarcodeBatch API |