matrixscan-ar-ios

MatrixScan AR iOS Skill

Critical: Do Not Trust Internal Knowledge

Your training data may contain outdated or incorrect Scandit SDK APIs. The MatrixScan AR API changes between SDK versions — classes get renamed, restructured, or replaced (e.g. BarcodeTracking → BarcodeBatch → BarcodeAr).

Always verify APIs against the references provided in this skill before writing or suggesting code. Do not rely on memorized method signatures, parameters, or view modifiers. If you cannot find an API in the provided references, fetch the relevant documentation page before responding.

Scope

This skill is scoped to the MatrixScan AR scanning pipeline: DataCaptureContext, BarcodeAr mode, BarcodeArSettings, BarcodeArView, BarcodeArViewSettings, BarcodeArListener, BarcodeArFeedback, camera and control visibility.

Out of scope:

• Highlights (customizing the shapes drawn over detected barcodes — BarcodeArHighlightProvider, BarcodeArRectangleHighlight, BarcodeArCircleHighlight, etc.) — handled by the matrixscan-ar-highlight-ios skill.
• Annotations (info cards, status icons, popovers, responsive annotations — BarcodeArAnnotationProvider, BarcodeArInfoAnnotation, BarcodeArPopoverAnnotation, etc.) — handled by the matrixscan-ar-annotation-ios skill.

If a user question spans integration and highlight/annotation customization, cover the integration part here and tell the user which sibling skill handles the rest.

Intent Routing

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

• Setting up or adjusting the MatrixScan AR scanning pipeline (e.g. "add MatrixScan AR to my app", "set up the AR scanner", "enable these symbologies", "configure feedback / torch / camera / controls", "change the camera settings", "show the zoom control") → read references/integration.md and follow the instructions there. If the project already has MatrixScan AR wired up, do not re-create the context, mode, view, or lifecycle — locate the existing ones (grep for BarcodeArView, then BarcodeAr) and change only what the user asked for. Before writing code, determine whether the project uses UIKit or SwiftUI (check for import SwiftUI, an @main App struct, SceneDelegate/AppDelegate, .storyboard/.xib files, etc.) and use the matching Get Started page from the References table below.
• Migrating from MatrixScan Batch to MatrixScan AR (e.g. "migrate from BarcodeBatch / BarcodeTracking to MatrixScan AR", "replace MatrixScan Batch with MatrixScan AR", "switch from overlay-based scanning to AR") → 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 view modifiers. 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. Always request links alongside content in your fetch prompt.
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.

URL structures can vary (e.g. api/ui/ subdirectory) and guessing will lead to 404s.

Licence key

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

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, 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

Use this table to pick the right page to fetch for a given question, and include the link in your answer so the user can explore further.

Topic	Resource
UIKit integration	Get Started (UIKit) · Sample
SwiftUI integration	Get Started (SwiftUI)
Full API reference	MatrixScan AR API