matrixscan-ar-flutter
MatrixScan AR Flutter Skill
Critical: Do Not Trust Internal Knowledge
Your training data may contain outdated or incorrect Scandit SDK APIs. The BarcodeAr API changes between major SDK versions — class names, constructor signatures, provider interfaces, and the Flutter plugin import path 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. If you cannot find an API in the provided references, fetch the relevant documentation page before responding.
Flutter-specific gotchas worth flagging:
await ScanditFlutterDataCaptureBarcode.initialize()must be called (and awaited) inmain()beforerunApp(...), afterWidgetsFlutterBinding.ensureInitialized(). Forgetting this yields a platform-channel error that can look unrelated to initialization.BarcodeArViewis a FlutterStatefulWidget. Create it once ininitState()(not inbuild()), store it as a field, and embed it in the widget tree. Creating it insidebuild()tears it down and rebuilds the native view on every rebuild.- The highlight and annotation providers (
BarcodeArHighlightProvider,BarcodeArAnnotationProvider) returnFuture<BarcodeArHighlight?>andFuture<BarcodeArAnnotation?>respectively. These callbacks are async — do not return plain values. BarcodeArCustomHighlightandBarcodeArCustomAnnotationuse FlutterWidgetchildren that are serialized as snapshots. Animated widgets are captured as a still frame at render time — they will not animate inside the AR overlay.- The BLoC (or equivalent controller) owns
DataCaptureContext,BarcodeAr, and the camera lifecycle. TheStateclass holds theBarcodeArViewand implements the provider interfaces. - Camera permission is required on both iOS (
NSCameraUsageDescriptioninios/Runner/Info.plist) and Android (runtime request viapermission_handler— the plugin declares the manifest permission automatically). - The barcode AR import is
scandit_flutter_datacapture_barcode_ar— a separate barrel file from the mainscandit_flutter_datacapture_barcodeimport. Symbologyenum values use lowerCamelCase in Dart:Symbology.code128,Symbology.ean13Upca,Symbology.code39,Symbology.qr,Symbology.dataMatrix. Do not writeSymbology.Code128/Symbology.EAN13UPCA— that's the JS/TS form and will not compile in Dart.
Intent Routing
Based on the user's request, load the reference file before responding:
-
Integrating BarcodeAr from scratch (e.g. "add MatrixScan AR to my app", "set up barcode AR scanning", "how do I use BarcodeAr in Flutter", "how do I show highlights on tracked barcodes", "how do I show info annotations") → read
references/integration.mdand follow the instructions there. -
Migrating from BarcodeBatch / BarcodeTracking to BarcodeAr (e.g. "migrate from BarcodeBatch", "convert BarcodeBatch to BarcodeAr", "move from MatrixScan to MatrixScan AR", "replace BarcodeTracking with BarcodeAr", "upgrade my old MatrixScan code to AR") → read
references/migration.mdand follow the 10-step migration guide 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 an analyzer / 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:
- First check whether the page you already fetched contains a direct hyperlink to it — topic pages link directly to relevant API symbols.
- 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 vary across SDK versions and package paths (e.g. api/ui/ subdirectory) and guessing will lead to 404s.
Framework variant policy
Flutter apps use many state-management patterns (StatefulWidget, BLoC, Provider, Riverpod). Examples in this skill use the BLoC pattern because it matches the official MatrixScanARSimpleSample, keeps the scan pipeline cleanly separated from the widget tree, and composes well with the camera lifecycle. If the target project already uses a different pattern (Provider, Riverpod, GetX, plain StatefulWidget), keep the BarcodeAr wiring conceptually the same (one owner holds DataCaptureContext, BarcodeAr, and exposes session data to the UI) and port the code snippets into the project's existing convention — do not rewrite the project's state management.
References
Direct users to the right resource based on their question:
| Topic | Resource |
|---|---|
| Flutter integration | Get Started · Sample |
| Full API reference | BarcodeAr API |
More from scandit/scandit-sdk-skills
data-capture-sdk
Use when a user mentions Scandit, data capture SDK, barcode scanning products, smart data capture, choosing a scanning product, comparing scanning features, supported barcode symbologies, system requirements, device compatibility, or Scandit pricing. Helps choose the right Scandit product (SparkScan, Barcode Capture, MatrixScan, Smart Label Capture, ID Capture, etc.), points to the correct documentation and sample apps for their platform, and hands off to implementation skills.
19sparkscan-ios
Use when SparkScan is involved in an iOS project — whether the user mentions SparkScan directly, or the codebase already uses SparkScan as its barcode scanning library and something needs to be added, changed, fixed, or migrated. This includes adding SparkScan to a new iOS app, modifying scan settings, handling scan results, customizing the SparkScan UI, upgrading between SDK versions, troubleshooting SparkScan behavior, or replacing a third-party barcode scanning library with SparkScan. If the project is iOS and SparkScan is in play, use this skill.
13matrixscan-batch-rn
Use when MatrixScan, MatrixScan Batch, BarcodeBatch, or BarcodeTracking (legacy alias) are involved in a React Native project — whether the user mentions these names directly, or the codebase already uses BarcodeBatch* classes and something needs to be added, changed, fixed, or extended. This includes adding MatrixScan Batch to a new React Native app, configuring BarcodeBatchSettings and symbologies, wiring BarcodeBatchListener.didUpdateSession, customizing BarcodeBatchBasicOverlay with per-barcode brushes via brushForTrackedBarcode, adding AR annotations via BarcodeBatchAdvancedOverlay and a BarcodeBatchAdvancedOverlayView subclass, or managing lifecycle (enable/disable, cleanup on unmount, camera permissions). If the project is React Native and MatrixScan / BarcodeBatch is in play, use this skill.
3label-capture-rn
Use when Label Capture (Smart Label Capture) is involved in a React Native project — whether the user mentions Label Capture directly, or the codebase already uses it and something needs to be added, changed, fixed, or customized. This includes adding Label Capture to a new React Native app, defining label structures (barcode fields + text fields with regex patterns), handling captured labels, enabling the Validation Flow, or upgrading between SDK versions. If the project is React Native and Label Capture is in play, use this skill.
3sparkscan-rn
Use when SparkScan is involved in a React Native project — whether the user mentions SparkScan directly, or the codebase already uses SparkScan as its barcode scanning library and something needs to be added, changed, fixed, or migrated. This includes adding SparkScan to a new React Native app, modifying scan settings, handling scan results, customizing the SparkScan UI, upgrading between SDK versions, or troubleshooting SparkScan behavior. If the project is React Native and SparkScan is in play, use this skill.
3sparkscan-web
Use when SparkScan is involved in an web project — whether the user mentions SparkScan directly, or the codebase already uses SparkScan as its barcode scanning library and something needs to be added, changed, fixed, or migrated. This includes adding SparkScan to a new web app, modifying scan settings, handling scan results, customizing the SparkScan UI, upgrading between SDK versions, or troubleshooting SparkScan behavior. If the project is a web project and SparkScan is in play, use this skill.
3