Skip to main content

Get Started

In this guide you will learn step-by-step how to add MatrixScan AR to your application. Implementing MatrixScan AR involves two primary elements:

  • Barcode AR: The data capture mode that is used for scan and check functionality.
  • A Barcode AR View: The pre-built UI elements used to highlight items to be checked.

The general steps are:

  • Creating a new Data Capture Context instance
  • Configuring the Barcode AR Mode
  • Setup the Barcode AR View
  • Registering the Listener to notify about found items

Prerequisites​

Before starting with adding a capture mode, make sure that you have a valid Scandit Data Capture SDK license key and that you added the necessary dependencies. If you have not done that yet, check out this guide.

note

You can retrieve your Scandit Data Capture SDK license key by signing in to your Scandit account.

Create a Data Capture Context​

The first step to add find capabilities to your application is to create a new DataCaptureContext. The context expects a valid Scandit Data Capture SDK license key during construction.

var dataCaptureContext = DataCaptureContext.forLicenseKey("-- ENTER YOUR SCANDIT LICENSE KEY HERE --");

Configure the Barcode AR Mode​

The main entry point for the Barcode AR Mode is the BarcodeAr object. You can configure the supported Symbologies through its BarcodeArSettings, and set up the list of items that you want MatrixScan AR to highlight.

Here we configure it for tracking EAN13 codes, but you should change this to the correct symbologies for your use case.

var settings = BarcodeArSettings();
settings.enableSymbology(Symbology.ean13Upca, true);

The create the mode with the previously created settings:

var mode = BarcodeAr(settings);
mode.setItemList(items);

Setup the BarcodeArView​

MatrixScan AR’s built-in AR user interface includes buttons and overlays that guide the user through the scan and check process. By adding a BarcodeArView, the scanning interface is added automatically to your application.

The BarcodeArView is where you provide the highlightProvider and/or annotationProvider to supply the highlight and annotation information for the barcodes to be checked. If null, a default highlight is used and no annotations are provided.

The BarcodeArView appearance can be customized through BarcodeArViewSettings, and the corresponding settings for your desired highlights and/or annotations, to match your application’s look and feel. The following settings can be customized:

  • Audio and haptic feedback
  • Torch button visibility and its position
  • Switch camera button visibility and its position
  • Zoom control visibility and its position
  • The size, colors, and styles of the highlight and annotation overlays
var viewSettings = BarcodeArViewSettings(
// ...
);

Next, create a BarcodeArView instance with the Data Capture Context and the settings initialized in the previous step. The BarcodeArView is automatically added to the provided parent view.

var barcodeArView = BarcodeArView.forModeWithViewSettings(dataCaptureContext, barcodeAr, viewSettings);

Connect the BarcodeArView to the Widget lifecycle. The widget is dependent on calling widgetPaused and widgetResumed to set up the camera and its overlays properly.

@override
void didChangeAppLifecycleState(AppLifecycleState state) {
if (state == AppLifecycleState.resumed) {
// Resume scanning by calling the BarcodeArView widgetResumed function.
// Under the hood, it re-enables the BarcodeAr mode and makes sure the view is properly
// setup.
barcodeArView.widgetResumed();
} else {
// Pause scanning by calling the BarcodeArView widgetPaused function.
// Under the hood, it will disable the mode and free resources that are not needed in a
// paused state.
barcodeArView.widgetPaused();
}
}

Register the Listener​

Register a BarcodeArViewUiListener to be notified what items have been found once the finish button is pressed.

In this tutorial, we will then navigate back to the previous screen to finish the session.

barcodeArView.uiListener = this

@override
void didTapFinishButton(Set<BarcodeArItem> foundItems) {
}

Start searching​

As soon as everything is set up, control the BarcodeArView to start the search.

barcodeArView.start();