SDK Documentation Help

Best Practices for Scanning Apps

This guide contains a collection of advice for building great scanning apps. While no two apps are the same, we believe that the recommendations in this guide are pretty universal.

Configure only the symbologies you need

Typically scanning apps only scan certain types of barcodes. It is therefore important to enable only those types, and to avoid enabling types that are not needed. This avoids unnecessary image processing and computation dedicated to locating and decoding these types.

Example: setting supported symbologies to Code 128 linear barcodes and QR codes:

const configuration = { // ... engine: { symbologies: [ "code128", "qr" ] } // ... };

EngineConfiguration API Reference

Enable audio and vibration feedback

Audio and vibration user feedback is not a gimmick, it is an important part of the scanning user experience. There's nothing that can replace that satisfying beep after scan.

const configuration = { // ... feedback: { audio: true, vibration: true } // ... };

FeedbackConfiguration API Reference

Choose an appropriate region of interest

The region of interest specifies the extent of the video feed where STRICH should to locate and decode barcodes. The larger this region is, the more time is spent in computation, and the longer it may take for a barcode to be detected.

Humans have a tendency to center the object of interest in their field of view. This principle (let's call it centrality) can also be applied to a camera feed. Make sure the region of interest is centered and its extent is appropriate for the barcode type. The region of interest is bounded by a viewfinder in the overlay, users will naturally try to center the barcode in the viewfinder.

Example 1: narrow region of interest, suitable for 1D barcodes

const configuration = { // ... locator: { regionOfInterest: { // restrict active area to a horizontal bar in the center left: 0.05, right: 0.05, top: 0.4, bottom: 0.4 } } // ... };
Horizontal region of interest

Example 2: square region of interest, suitable for 2D barcodes

const configuration = { // ... locator: { regionOfInterest: { // restrict active area to a square-shaped region in the center left: 0.2, right: 0.2, top: 0.3, bottom: 0.3 } } // ... };
Square region of interest

LocatorConfiguration API Reference

Adding manual entry capability

There is always a possibility that a barcode type is supported by STRICH but can't be scanned because it is too damaged or otherwise illegible. Adding a fallback option to input a code manually using the smartphone's on-screen keyboard is therefore always recommended, especially for critical applications.

A subtle keyboard icon that toggles visibility of an input field, and focuses the field so the keyboard pops up usually works fine.

Last modified: 31 October 2023