Skip to main content

Get Started

This page describes the steps to add MatrixScan Count to your application.

note

MatrixScan Count is implemented via BarcodeCount.

The general steps are:

  • Create a new Data Capture Context instance
  • Configure the Barcode Count Mode
  • Obtain the camera instance and set frame source
  • Register the listener to be informed when scan phase is complete
  • Set the capture view and AR overlays
  • Configure the camera for scanning view
  • Store and retrieve the captured barcodes
  • Reset the Barcode Count Mode
  • List and exit callbacks

Create a Data Capture Context​

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.

DataCaptureContext 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.

Here we set up Barcode Count for tracking EAN13 codes, however you must change this to the appropriate symbologies for your use case. If you are sure that your environment has only unique barcodes, you can also enable BarcodeCountSettings.expectsOnlyUniqueBarcodes. This option improves scanning performance as long as you are sure that no duplicates are present.

BarcodeCountSettings settings = new BarcodeCountSettings();
settings.setSymbologyEnabled(Symbology.EAN13_UPCA, true);

Next, create a BarcodeCount instance with the Data Capture Context and the settings initialized in the previous step:

BarcodeCount barcodeCount = BarcodeCount.forDataCaptureContext(context, settings);

Camera Instance And Set Frame Source​

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

CameraSettings cameraSettings = BarcodeCount.createRecommendedCameraSettings();

Camera camera = Camera.getDefaultCamera();
camera.applySettings(cameraSettings);

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);

Registering the Listener​

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

// Register self as a listener to monitor the barcode count session.
barcodeCount.addListener(this);

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

Setting the 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 will be added automatically to your application.

Add a BarcodeCountView to your view hierarchy:

BarcodeCountView view = BarcodeCountView.newInstance(barcodeCount, captureView);

Configuring the Camera for 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 example, you should switch off the camera when the BarcodeCountView is not visible and switch on the camera when the BarcodeCountView is visible. For example:

@Override
protected void onPause() {
    camera.switchToDesiredState(FrameSourceState.OFF);
    super.onPause();
}

@Override
protected void onResume() {
    super.onResume();
    camera.switchToDesiredState(FrameSourceState.ON);
}

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.onScan.

We recommend 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
public void onScan(
    @NonNull BarcodeCount mode,
    @NonNull BarcodeCountSession session,
    @NonNull FrameData data
) {
    allRecognizedBarcodes = session.getRecognizedBarcodes().values();
}

Resetting the 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, call the BarcodeCount.reset method:

barcodeCount.reset()

List and Exit Callbacks​

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

extension ViewController: BarcodeCountViewUIDelegate {
    func listButtonTapped(for view: BarcodeCountView) {
        // Show the current progress but the order is not completed
    }

    func exitButtonTapped(for view: BarcodeCountView) {
        // The order is completed
    }
}