matrixscan-batch-android

---
name: matrixscan-batch-android
description: MatrixScan Batch (MatrixScan, BarcodeBatch, legacy BarcodeTracking) — tracking and scanning multiple barcodes at once in Android (Kotlin/Java) projects. Use for integration, settings and symbologies, tracked-barcode handling, basic/advanced overlay customization, lifecycle, or troubleshooting.
license: Apache-2.0
metadata:
  author: scandit
  version: "1.0.4"
---

# MatrixScan Batch Android 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 — constructor signatures, overlay factories, and listener method names 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, or property names. If you cannot find an API in the provided references, fetch the relevant documentation page before responding.

Android-specific gotchas worth flagging:

- `BarcodeBatch.forDataCaptureContext(dataCaptureContext, settings)` is a **factory method** — not a direct constructor and not `BarcodeBatch(settings)` (that is the Flutter ≥7.6 form).
- Camera setup is **manual**, exactly like BarcodeCapture: create `Camera.getDefaultCamera(BarcodeBatch.createRecommendedCameraSettings())`, call `dataCaptureContext.setFrameSource(camera)`, and drive the camera from `onResume`/`onPause`.
- `BarcodeBatchListener.onSessionUpdated` is called on a **recognition thread** — not the main thread. Dispatch any UI work via `runOnUiThread {}`.
- **Do not hold references** to `BarcodeBatchSession` or its collections outside the `onSessionUpdated` callback — the session is only safe to access within that callback.
- `BarcodeBatchBasicOverlay.newInstance(mode, view)` (and the style overload) **auto-adds the overlay to the view** — no separate `addOverlay` call needed.
- `BarcodeBatchAdvancedOverlay.newInstance(mode, view)` also auto-adds to the view.
- **Per-barcode brush customization** (`brushForTrackedBarcode`, `setBrushForTrackedBarcode`) requires the **MatrixScan AR add-on** license. The basic overlay with a uniform default brush does not.
- **BarcodeBatchAdvancedOverlay** requires the **MatrixScan AR add-on** license.
- Android listener method names differ from Flutter: `onTrackedBarcodeTapped` (not `didTapTrackedBarcode`), `viewForTrackedBarcode` (not `widgetForTrackedBarcode`), `clearTrackedBarcodeViews` (not `clearTrackedBarcodeWidgets`).
- `BarcodeBatchAdvancedOverlayListener` uses Android `View` objects — not Flutter Widgets.
- Android symbology names use underscores: `Symbology.EAN13_UPCA`, `Symbology.CODE128`, `Symbology.QR` — not camelCase.

## 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 (basic FRAME/DOT style, tap callbacks, advanced AR views, anchor/offset positioning), reacting to removed barcodes, or emitting feedback** → read [references/integration.md](references/integration.md) and follow the instructions there.
- **Migrating or upgrading an existing MatrixScan Batch integration** (e.g. "upgrade from v6 to v7", "rename BarcodeTracking to BarcodeBatch", "bump the Scandit SDK to v8", "what changed between SDK versions") → read [references/migration.md](references/migration.md) and follow the instructions there.
- **Replacing a third-party multi-barcode scanner with MatrixScan Batch** (e.g. "migrate from ML Kit barcode scanning to Scandit MatrixScan", "replace my ML Kit multi-barcode scanner with BarcodeBatch", "switch from [library] to MatrixScan Batch") → read [references/third-party-migration.md](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, 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:
1. First check whether the page you already fetched contains a direct hyperlink to it — topic pages link directly to relevant API symbols.
2. 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.

## Licence key

Scanning needs a Scandit licence key. For this skill the licence product is `native` and the licence platform is `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 `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

| Topic | Resource |
|---|---|
| Get Started | [Get Started](https://docs.scandit.com/sdks/android/matrixscan-batch/get-started/) · [Sample](https://github.com/Scandit/datacapture-android-samples/tree/master/03_Advanced_Batch_Scanning_Samples) |
| AR overlays (BasicOverlay brushes, AdvancedOverlay views) | [Adding AR Overlays](https://docs.scandit.com/sdks/android/matrixscan-batch/advanced/) |
| Full API reference | [BarcodeBatch API](https://docs.scandit.com/data-capture-sdk/android/barcode-capture/api.html) |

• SKILL.md 7 KB
• references/integration.md 24 KB
• references/migration.md 6 KB
• references/third-party-migration.md 6 KB