Get Started With MatrixScan#

With MatrixScan, you can highlight and interact multiple barcodes within the same frame and build AR experiences. MatrixScan use cases are implemented through functionality provided by Barcode Tracking.

In this guide you will learn step by step how to add Barcode Tracking to your application. Roughly, the steps are:

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 account at ssl.scandit.com.

Create the Data Capture Context#

The first step to add barcode 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.

self.context = DataCaptureContext(licenseKey: "-- ENTER YOUR SCANDIT LICENSE KEY HERE --")

Configure the Barcode Tracking Mode#

The main entry point for the Barcode Tracking Mode is the SDCBarcodeTracking object. It is configured through SDCBarcodeTrackingSettings and allows to register one or more listeners that will get informed whenever a new frame has been processed.

Most of the times, you will not need to conform to SDCBarcodeTrackingListener, instead you will add a SDCBarcodeTrackingBasicOverlay and conform to SDCBarcodeTrackingBasicOverlayDelegate.

For this tutorial, we will setup Barcode Tracking for tracking QR codes.

let settings = BarcodeTrackingSettings()
settings.set(symbology: .qr, enabled: true)

Next, create a SDCBarcodeTracking instance with the data capture context and the settings initialized in the previous steps:

barcodeTracking = BarcodeTracking(context: context, settings: settings)

Use the Built-in Camera#

The data capture context supports using different frame sources to perform recognition on. Most applications will use the built-in camera of the device, e.g. the world-facing camera of a device. The remainder of this tutorial will assume that you use the built-in camera.

When using the built-in camera there are recommended settings for each capture mode. These should be used to achieve the best performance and user experience for the respective mode. The following couple of lines show how to get the recommended settings and create the camera from it:

let cameraSettings = BarcodeCapture.recommendedCameraSettings

// Depending on the use case further camera settings adjustments can be made here.

let camera = Camera.default
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 SDCDataCaptureContext.setFrameSource:completionHandler::

context.setFrameSource(camera)

The camera is off by default and must be turned on. This is done by calling SDCFrameSource.switchToDesiredState:completionHandler: with a value of SDCFrameSourceStateOn:

camera?.switch(toDesiredState: .on)

There is a separate guide for more advanced camera functionality.

Use a Capture View to Visualize the Scan Process#

When using the built-in camera as frame source, you will typically want to display the camera preview on the screen together with UI elements that guide the user through the capturing process. To do that, add a SDCDataCaptureView to your view hierarchy:

let captureView = DataCaptureView(for: context, frame: view.bounds)
captureView.dataCaptureContext = context
captureView.autoresizingMask = [.flexibleWidth, .flexibleHeight]
view.addSubview(captureView)

To visualize the results of Barcode Tracking, first you need to add the following overlay:

let overlay = BarcodeTrackingBasicOverlay(barcodeTracking: barcodeTracking, view: captureView)

Once the overlay has been added, you should conform to the SDCBarcodeTrackingBasicOverlayDelegate protocol. The method SDCBarcodeTrackingBasicOverlayDelegate.barcodeTrackingBasicOverlay:brushForTrackedBarcode: is invoked every time a new tracked barcode appears and it can be used to set a brush that will be used to highlight that specific barcode in the overlay.

extension ViewController: BarcodeTrackingBasicOverlayDelegate {
    func barcodeTrackingBasicOverlay(_ overlay: BarcodeTrackingBasicOverlay,
                                brushFor trackedBarcode: TrackedBarcode) -> Brush? {
        // Return a custom Brush based on the tracked barcode.
    }
}

If you would like to make the highlights tappable, you need to implement the SDCBarcodeTrackingBasicOverlayDelegate.barcodeTrackingBasicOverlay:didTapTrackedBarcode: method.

extension ViewController: BarcodeTrackingBasicOverlayDelegate {
    func barcodeTrackingBasicOverlay(_ overlay: BarcodeTrackingBasicOverlay,
                                didTap trackedBarcode: TrackedBarcode) {
        // A tracked barcode was tapped.
    }
}

Get Barcode Tracking Feedback#

Barcode Tracking, unlike Barcode Capture, doesn’t emit feedback (sound or vibration) when a new barcode is recognized. However, you may implement a SDCBarcodeTrackingListener to provide a similar experience. Below, we use the default SDCFeedback, but you may configure it with your own sound or vibration if you want.

First, let’s create a feedback.

override func viewDidLoad() {
    super.viewDidLoad()
    feedback = Feedback.default
}

Next, use this feedback in a SDCBarcodeTrackingListener:

extension ScanningViewController: BarcodeTrackingListener {
    func barcodeTracking(_ barcodeTracking: BarcodeTracking,
                             didUpdate session: BarcodeTrackingSession,
                             frameData: FrameData) {
        if !session.addedTrackedBarcodes.isEmpty {
            feedback?.emit()
        }
    }
}

SDCBarcodeTrackingListener.barcodeTracking:didUpdate:frameData: is invoked for every processed frame. The session parameter contains information about the currently tracked barcodes, in particular, the newly recognized ones. We check if there are any and if so, we emit the feedback.

As the last step, register the delegate responsible for emitting the feedback with the SDCBarcodeTracking instance.

barcodeTracking.addListener(self)

Limitations#

Matrix scan does not support the following symbologies:

  • DotCode

  • MaxiCode

  • All postal codes (KIX, RM4SCC)

What’s next?

To dive further into the Scandit Data Capture SDK we recommend the following articles: