barcode-capture-flutter
Installation
SKILL.md
BarcodeCapture Flutter Skill
Critical: Do Not Trust Internal Knowledge
Your training data may contain outdated or incorrect Scandit SDK APIs. The BarcodeCapture API changes significantly between major SDK versions — properties get renamed, removed, or restructured, and the Flutter plugin surface (imports, plugin initialization, pub packages) has also 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.- A single
DataCaptureContextmust own theBarcodeCapturemode and theDataCaptureView. Do not construct multiple contexts per page or perMaterialApp; the BLoC / controller that holds the context should outlive any singleState. - The
DataCaptureViewis a FlutterWidgetreturned fromDataCaptureView.forContext(context)— you must explicitly add theBarcodeCaptureOverlayto it viaview.addOverlay(...). Unlike SparkScan, there is no pre-built scanning UI; the overlay is the only thing that visualizes recognized barcodes on the camera preview. BarcodeCaptureListener.didScan(...)blocks the recognition pipeline until it returns. Disable the mode (barcodeCapture.isEnabled = false) before doing any meaningful work in the callback, and re-enable it (or stop the camera) when finished — otherwise duplicate / unwanted scan events will fire.- The
getFrameDataparameter on the Flutter listener is aFuture<FrameData?> Function()— frame data is fetched lazily. Only invoke it if you actually need the frame data, since it crosses the platform channel. flutter pub getmust be run after every package version change. On iOS, the Podfile resolves transitively — no manual pod install needed unless the user has a custom setup.- Camera permission is required on both iOS (
NSCameraUsageDescriptioninios/Runner/Info.plist) and Android (runtime request viapermission_handler— the plugin declares the manifest permission automatically). - Hot-reload does not re-run
main(), so the camera lifecycle (and theScanditFlutterDataCaptureBarcode.initialize()call) survive a hot reload. A full restart is needed to re-trigger plugin init. Drivecamera.switchToDesiredState(...)fromWidgetsBindingObserver.didChangeAppLifecycleStateso the camera turns off inpausedand back on inresumed.