| name | label-capture-android |
| description | Smart Label Capture (Scandit `LabelCapture`) in native Android projects — extracting multiple fields (price, expiry date, serial or lot number, weight) from a label in one scan, using barcode fields plus text fields with regex patterns and pre-built definitions like price capture. Use for integration, label-definition configuration, captured-session handling, overlay customization (brushes, floating badges), the Validation Flow, and SDK version migration. |
| license | MIT |
| metadata | {"author":"scandit","version":"1.2.1"} |
Label Capture Android Skill
Critical: Do Not Trust Internal Knowledge
Your training data may contain outdated or incorrect Scandit Label Capture APIs. Label Capture has evolved across recent SDK releases:
- At the v7→v8 major bump,
LabelFieldDefinition regex builder methods were renamed (setPattern→setValueRegex, setPatterns→setValueRegexes, setDataTypePattern→setAnchorRegex, setDataTypePatterns→setAnchorRegexes).
- At v8.2, Validation Flow 2.0 introduced
shouldHandleKeyboardInsetsInternally on LabelCaptureValidationFlowOverlay — relevant for Android 15 edge-to-edge enforcement.
- Android symbology names use underscores:
Symbology.EAN13_UPCA, not Symbology.EAN13UPCA.
Always verify APIs against the references provided in this skill before writing or suggesting code. Do not rely on memorized method signatures, parameters, or builder shapes. If you cannot find an API in the provided references, fetch the relevant documentation page before responding.
Label Capture is broader than it looks — two reflexes that prevent most failures
Label Capture ships a rich catalogue of pre-built fields and whole pre-built label definitions for the data people actually scan — serial numbers, IMEI 1 & 2, expiry/packing dates, prices, weights, VINs, seven-segment displays. The two most common ways an integration goes wrong are forgetting these exist, and crashing at runtime over a missing model artifact. Two reflexes:
-
Reach for a pre-built field or pre-built label before composing anything custom. When the user names a recognisable thing to scan — "serial number", "IMEI", "expiry date", "price/shelf label", "VIN" — there is almost always a dedicated builder or a whole-label factory tuned for it, with anchor/value regexes already dialled in. Use it. Inventing a custom barcode/text field with a hand-written regex for something that has a pre-built builder is the single biggest source of bad integrations: the regex you guess will not match real labels as well as the tuned one, and it signals you didn't know the pre-built existed. Only fall back to addCustomBarcode()/addCustomText() when nothing pre-built fits. The full catalogue and the routing rules live in references/integration.md — consult it rather than relying on memory.
-
Bundle the right model artifacts whenever any pre-built field or definition is used — getting this wrong is the #1 runtime failure. label-text-models is not only for text fields: serial number, IMEI, and part-number fields are "barcode" fields but still load a model at runtime. And label-text-models alone is not enough for the pre-built whole-label factories — createPriceCaptureDefinition additionally needs com.scandit.datacapture:price-label. Miss it and the app compiles and launches but never scans. references/integration.md has the per-field and per-factory artifact rules; map every pre-built thing you use to its artifact(s) before writing the Gradle block.
Constraint: Label Capture cannot run alongside Barcode Capture
A DataCaptureContext runs only one active mode at a time, so Label Capture and Barcode Capture cannot both be active simultaneously — attaching both makes the context error out. If the user wants to read a standalone barcode "as well as" the label, model that barcode as a field inside the label definition (addCustomBarcode() or a pre-built barcode field) rather than adding a second mode — this is the answer in almost every case. (Only when they genuinely need two distinct scanning steps do you switch the active mode with setMode().) See references/integration.md.
Intent Routing
Based on the user's request, load the appropriate reference file before responding:
- Integrating Label Capture from scratch (e.g. "add Label Capture to my Android app", "scan a price tag with barcode and expiry date", "scan serial numbers / IMEI off a phone box", "read a VIN", "how do I use Smart Label Capture") → read
references/integration.md and follow the instructions there. It contains the full pre-built field catalogue and the pre-built whole-label definitions — consult it before composing any custom field or regex.
- Enabling or customizing the Validation Flow (e.g. "how do I enable the Validation Flow", "add the validation flow overlay", "customize the placeholder text / button labels in the validation flow", "how do I handle the result from the validation flow") → read
references/validation-flow.md and follow the instructions there.
- Customizing overlays, adding custom AR views, troubleshooting, or cloud Adaptive Recognition (e.g. "customize the field highlight brushes / labelBrush", "color the price field green when it's correct", "outline the captured label", "show a checkmark / badge / icon above a field", "use LabelCaptureBasicOverlayListener / brushForField / brushForLabel", "add a custom AR view over a field with the Advanced Overlay", "viewForCapturedLabel(Field)", "scan a seven-segment display", "camera preview is black", "app crashes on launch building the label", "enable the cloud fallback / Adaptive Recognition Engine / ARE", "scan receipts") → read
references/advanced.md (overlay customization and composition, Advanced Overlay — including the per-field-listener-has-no-label-context trap — seven-segment, Adaptive Recognition and Receipt Scanning beta). Troubleshooting symptoms are covered at the end of references/integration.md.
- Migrating or upgrading an existing Label Capture integration (e.g. "upgrade my Label Capture to the latest SDK", "migrate from v7 to v8", "what changed between SDK versions for Label Capture", "keyboard covers the input in Validation Flow after upgrading", "migrate Validation Flow to 2.0") → read
references/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 builder shapes. 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 (e.g. the Advanced Configurations page) 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 and guessing will lead to 404s.
References
Direct users to the right resource based on their question:
