Skip to main content

Get Started

In this guide you will learn step-by-step how to add MatrixScan Count to your application.

The general steps are:

  1. Create a new Data Capture Context instance
  2. Configure the Barcode Count Mode
  3. Obtain camera instance and set frame source used
  4. Register the listener to be informed when scanned phase is over
  5. Set capture view and AR overlays
  6. Set up the camera so that it switches on when you are in scanning view
  7. Store and retrieve scanned barcodes
  8. Reset Barcode Count mode
  9. List and Exit callbacks

Create A New Data Capture Context Instance​

The first step to add capture capabilities to your application is to create a new Data Capture Context. 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 Count Mode​

The main entry point for the Barcode Count Mode is the BarcodeCount object. It is configured through BarcodeCountSettings and allows you to register one or more listeners that are informed whenever a scan phase has finished.

For this tutorial, we will set up Barcode Count for tracking EAN13 codes. Change this to the correct symbologies for your use case (for example, Code 128, Code 39…).

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

If you are sure that your environment will only have unique barcodes (i.e. no duplicated values), you can also enable BarcodeCountSettings.expectsOnlyUniqueBarcodes. This option improves scanning performance as long as you are sure that no duplicates will be present. Next, create a BarcodeCount instance with the Data Capture Context and the settings initialized in the previous step:

var barcodeCount = BarcodeCount.forContext(dataCaptureContext, settings);

Obtain Camera Instance And Set Frame Source Used​

Our recommended camera settings should be used to achieve the best performance and user experience. The following couple of lines show how to get the recommended settings for MatrixScan Count and create the camera from it:

Because the frame source is configurable, the data capture context must be told which frame source to use. This is done with a call to DataCaptureContext.setFrameSource():

dataCaptureContext.setFrameSource(camera);

Register the Listener​

To keep track of the barcodes that have been scanned, implement the BarcodeCountListener interface and register the listener.

barcodeCount.addListener(this);

BarcodeCountListener.didScan() is called when the scan phase has finished and results can be retrieved from BarcodeCountSession.

Set Capture View And AR Overlays​

MatrixScan Count’s built-in AR user interface includes buttons and overlays that guide the user through the capturing process. By adding a BarcodeCountView the scanning interface (camera preview and scanning UI elements) will be added automatically to your application.

Add a BarcodeCountView to your view hierarchy:

var barcodeCountView = BarcodeCountView.forContextWithMode(dataCaptureContext, barcodeCount);

Set Up The Camera So That It Switches On When You Are In Scanning View​

The camera is not automatically turned on when you are in a scanning view. You need to set up the camera so that it switches on when needed and it switches off when not needed anymore. Similarly BarcodeCount should also be enabled and disabled. For instance, you should switch off the camera when the BarcodeCountView is not visible anymore (including when the app goes in the background), similarly you want to switch on the camera when the BarcodeCountView is visible (including when the app goes to the foreground). One way to achieve this is the following:

@override
void didChangeAppLifecycleState(AppLifecycleState state) {
if (state == AppLifecycleState.resumed) {
camera.switchToDesiredState(FrameSourceState.on);
} else if (state == AppLifecycleState.paused) {
camera.switchToDesiredState(FrameSourceState.off);
}
}

Store And Retrieve Scanned Barcodes​

The values captured as part of the scanning process are part of the session, and the session is not accessible outside BarcodeCountListener.didScan(). Therefore, we recommend that you store the values to present a list, for example when the user taps the list icon. To do this, make a copy of BarcodeCountSession.recognizedBarcodes:

@override
void didScan(BarcodeCount barcodeCount, BarcodeCountSession session, Future<FrameData> Function() getFrameData) {
	allRecognizedBarcodes = session.recognizedBarcodes.values;
}

Reset Barcode Count Mode​

When the scanning process is over, you need to reset the mode to make it ready for the next process. This clears the list of barcodes scanned and all the AR overlays.

To reset Barcode Count’s scanning process, you need to call the BarcodeCount.reset() method.

barcodeCount.reset();

List And Exit Callbacks​

The UI includes two icons (buttons) named “List” and “Exit”. The SDK provides the callbacks so you can add the desired action when those icons are tapped by the user.

@override
void didTapListButton(BarcodeCountView view) {
// Show the current progress but the order is not completed
}

@override
void didTapExitButton(BarcodeCountView view) {
// The order is completed
}