matrixscan-batch-capacitor

MatrixScan Batch Capacitor Skill

Critical: Do Not Trust Internal Knowledge

Your training data may contain outdated or incorrect Scandit SDK APIs. The BarcodeBatch* API surface changes between major SDK versions — constructor signatures, overlay constructors, and listener shapes have all evolved.

Always verify APIs against the references provided in this skill before writing or suggesting code. Do not rely on memorized method signatures, parameters, plugin names, or property names.

Capacitor-specific gotchas worth flagging:

• ScanditCaptureCorePlugin.initializePlugins() must be called (and awaited) before any other Scandit API — including DataCaptureContext.initialize. Forgetting this produces runtime errors that look unrelated to initialization.
• npx cap sync must be run after every plugin version change to propagate native artifacts into iOS/Android. Skipping it yields a web/native version mismatch at runtime.
• context.setMode(barcodeBatch) is how the mode is registered in the context on Capacitor (confirmed from both samples). This replaces any previously active mode.
• DataCaptureView.forContext(context) is the Capacitor factory for the capture view. Then call view.connectToElement(htmlElement) to attach it to the DOM.
• Modern constructors require SDK 7.6+: new BarcodeBatch(settings), new BarcodeBatchBasicOverlay(mode, style), new BarcodeBatchAdvancedOverlay(mode), and BarcodeBatch.createRecommendedCameraSettings() are all available from capacitor=7.6.
• AdvancedOverlay uses serialized views: On Capacitor, setViewForTrackedBarcode accepts view: Promise<TrackedBarcodeView?> — a serialized TrackedBarcodeView, NOT a native UI instance. Use TrackedBarcodeView.withHTMLElement(domElement, options) from scandit-capacitor-datacapture-barcode. Wrap it in a Promise or pass directly — the sample passes the instance directly (the API internally wraps it).
• MatrixScan AR add-on required: BarcodeBatchAdvancedOverlay, IBarcodeBatchBasicOverlayListener.brushForTrackedBarcode, and setBrushForTrackedBarcode all require the MatrixScan AR add-on license.
• Camera permission: iOS requires NSCameraUsageDescription in Info.plist. Android is handled automatically by the plugin.
• TrackedObject (Capacitor 8.2+): In SDK 8.2+, a TrackedObject base class was introduced that TrackedBarcode extends. No recipe is needed for this — the TrackedBarcode API you use day-to-day is unchanged.

Intent Routing

Based on the user's request, load the appropriate reference file before responding:

• Integrating MatrixScan Batch from scratch (e.g. "add MatrixScan to my app", "set up BarcodeBatch", "track multiple barcodes simultaneously", "show AR overlays", "per-barcode brushes", "tap handling", "overlay style (frame/dot)", "feedback / beep / vibration on scan", "lifecycle or cleanup", "camera permissions") → read references/integration.md and follow the instructions there.
• Upgrading the Scandit SDK version (e.g. "migrate from v6/v7 to v8", "BarcodeTracking is gone", "rename BarcodeTracking to BarcodeBatch", "DataCaptureContext.forLicenseKey not found") → read references/migration.md and follow the instructions there.
• Replacing a third-party multi-barcode scanner (e.g. "switch from @capacitor-mlkit/barcode-scanning / ML Kit to MatrixScan Batch", "replace BarcodeScanner.startScan and barcodesScanned with Scandit") → read references/third-party-migration.md and follow the instructions there.

API Usage Policy

Only use APIs that are explicitly documented in the Scandit references below. Do not invent or guess method signatures, parameters, property names, or imports. If unsure whether an API exists or how it is called — or if a TypeScript / runtime 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:

1. First check whether the page you already fetched contains a direct hyperlink to it.
2. If no direct link was found, fetch the API index, extract the actual link from it, and follow that.

URL structures vary across SDK versions and package paths and guessing will lead to 404s.

Framework variant policy

Capacitor is a WebView-based framework. Examples in this skill use plain JavaScript (ES modules). TypeScript projects can use the same imports and APIs verbatim — just add types — but this skill does not assume a TypeScript project by default. If the target project is clearly TypeScript (.ts files, tsconfig.json), adapt the final output to TypeScript syntax; otherwise stay in plain JS.

Licence key

Scanning needs a Scandit licence key. For this skill the licence product is native and the licence platforms are ios and android.

Work through these in order — never block the user on MCP:

1. The Scandit MCP server is connected — call ensure_scanner_setup with product native and platforms ios and android, app_identifier (the app's bundle or application id; for web, its production domain, never localhost) and env_var SCANDIT_LICENSE_KEY. Do not run the command it returns. Then call get_license_key with the key's id, from that result or from list_license_keys; if list_license_keys shows the key is not a trial, ask the user before fetching it. Show at most a masked preview in chat; never print a full key.

2. It is not connected — tell the user once that they can connect the remote Scandit MCP server, https://ssl.scandit.com/mcp, in their MCP client, then continue from step 1. Do not edit MCP client configuration yourself.

   Authentication is browser-based, so it is not supported headless or in CI. The server provisions trial keys only; it never creates, revokes, or modifies production licences.

3. The user declines, or has no MCP client — they generate a key themselves at https://ssl.scandit.com (no account yet: https://ssl.scandit.com/dashboard/sign-up?p=test) and paste it in.

Then put the key into the code: write it into the licence-key call in place of the placeholder — the key get_license_key returned, or the one the user pastes or gives you — still showing only a masked preview in chat. Do not search the project, its files or the environment for a key.

References

Direct users to the right resource based on their question:

Topic	Resource
Capacitor get started	Get Started
Capacitor AR overlays	Adding AR Overlays
Bubbles sample	MatrixScanBubblesSample
Full API reference	BarcodeBatch API