Advanced Configurations

SparkScan is optimized by default for efficiency, accuracy, and responsiveness. However, there are some cases where you might want to customize the behavior of SparkScan. This guide will show you how to add additional capabilities and further customize SparkScan to best fit your needs.

Advanced Capabilities

Trigger Error State

You may want to introduce logic in your app to show an error message when scanning specific barcodes (for example, barcodes already added to the list, barcodes from the wrong lot etc.). SparkScan offers a built-in error state you can easily set to trigger an error feedback prompt to the user. You will be able to customize:

• The text message

• The timeout of the error message: the scanner will be paused for the specified amount of time, but the user can quickly restart the scanning process by tapping the trigger button

  tip

  A high timeout (>10s) typically requires the users to interact with the UI to start scanning again. This is a good choice when you want to interrupt the scanning workflow (for example, because a wrong barcode is scanned and some actions need to be performed). A small timeout (<2s) could allow the user to scan again without having to interact with the app, just momentarily pausing the workflow to acknowledge that a “special” barcode has been scanned.

• The color of the flashing screen upon scan. You can enable or disable the visual feedback via SparkScanViewSettings.visualFeedbackEnabled and you can control the color via SparkScanBarcodeFeedback.

An error example is here reported:

To emit an error, you have to implement a SparkScanFeedbackDelegate and set it to the SparkScanView:

sparkScanView.feedbackDelegate  = sparkScanFeedbackDelegate;

In the SparkScanFeedbackDelegate.getFeedbackForBarcode() you can then return an error or a success feedback:

const sparkScanFeedbackDelegate = {
      getFeedbackForBarcode: (barcode: Barcode) => {
          if (isValidBarcode(barcode)) {
              return new SparkScanBarcodeSuccessFeedback();
          } else {
              return new SparkScanBarcodeErrorFeedback(
                  'This code should not have been scanned',
                  60 * 1000,
                  Color.fromHex('#FF0000'),
                  new Brush(Color.fromHex('#FF0000'), Color.fromHex('#FF0000'), 1),
              );
          }
      },
};

You can have different error states triggered by different logic conditions. These errors can show different colors and have different timeouts. For example:

This error state for a code that should not have been scanned.

This error state for a code that has been scanned more than once.

Reject Barcodes

To prevent scanning unwanted barcodes (like those already listed or from incorrect lots), use SparkScan’s built-in error state. Setting the SparkScanBarcodeErrorFeedback.resumeCapturingDelay parameter to 0 allows the user to continue scanning immediately without pausing on rejected codes.

UI Customization

tip

Please refer to SparkScanView for the full list of parameters.

You can customize many aspects of the default SparkScan UI and UX to suit your needs and particular use case. These customizations include the:

• Colors of all items (i.e. icons, buttons, toolbar)
• Trigger button icon
• All toast messages
• Size of the preview
• Visibility of any/all icons
• Trigger button

Trigger button

The default SparkScan trigger button is optimized for common industry use cases based on customer feedback and implementation experience. Custom trigger implementations are also supported.

This is achieved by hiding the default trigger button (via sparkScanView.triggerButtonVisible), and then controlling the scanning process as best suits your needs:

• Using a custom button embedded in you app to call sparkScanView.startScanning() to start scanning. You can adapt the trigger button to the state changes using the SparkScanViewUiListener.
• Using the mini-preview close button (via sparkScanView.previewCloseControlVisible) or your desired button (via sparkScanView.pauseScanning()) to stop scanning.

Some example customizations:

Customized Self-Scanning application with custom FAB button and preview expanded by default

Customized mPOS application using the existing scan button to trigger the scanner

Settings Toolbar

The Settings Toolbar is hidden by default in SparkScan, as the most relevant controls are already visible in the camera preview. However, additional advanced controls can be made available, such as:

• Target Mode
• Continuos Mode

By enabling the visibility of these buttons, the Settings Toolbar will appear at the bottom of the camera preview.

Add Advanced Scanning Modes to the Toolbar

SparkScan is our best solution for high-speed single scanning and scan-intensive workflows. Depending on your use case, you can use SparkScan in conjunction with other Scandit advanced scanning modes, such as MatrixScan Find or Label Capture, to speed up your workflows.

SparkScan offers pre-build buttons you can add to the setting toolbar to easily move to different scan modes from within the SparkScan UI.

First you will need to show these buttons:

// Show the Label Capture and MatrixScan Find buttons
sparkScanView.labelCaptureButtonVisible = true
sparkScanView.barcodeFindButtonVisible = true

The standard toolbar without additional scanning modes added.

The toolbar with MatrixScan Find and Label Capture buttons.

In addition you have to add a delegate to the SparkScanView via sparkScanView.setListener(). You will then receive callbacks when the MatrixScan Find button or Label Capture button is tapped from the toolbar.

Workflow Options

This section explains all the available options to configure SparkScan to best fit your case, in case you found something that didn't work well in the default configuration (that remains our recommended option).

Developers can set a combination of selection mode, scanning behavior and camera preview behavior, defining the initial state of the scanner. Set the selection mode with SparkScanSettings.selectionMode, and the two behaviors with SparkScanViewSettings.scanningBehavior and SparkScanViewSettings.previewBehavior. This combination allows for flexible configurations to suit different scanning needs.

Selection Mode

The selection mode determines whether an aimer is shown in the preview to help with precision scanning.

Mode	Description
Auto	The SDK decides: it shows an aimer only when several barcodes are in view and the user shows no clear intention to scan one of them.
Off	This is the default. No aimer. This mode displays a small camera preview to aid with aiming. The preview size and zoom level can be adjusted as needed. The user can aim easily at the intended barcode.
On	This mode always adds an aimer to the camera preview, and the user confirms the aimed barcode with the trigger button. This is recommended only when selecting among many close barcodes is the common task.

tip

Auto requires SparkScanSettings.scanIntention to be set to Smart. With Manual, it behaves like Off. Setting the selection mode to On forces the aimer to be shown at all times.

Scanning Behavior

The scanning behavior determines how barcodes are scanned - one at a time or continuously.

Behavior	Description
Single scan	Scan one barcode at a time. The user needs to trigger the scanner every time to scan a barcode. This allows for a more controlled scanning and lower battery consumption.
Continuous scan	Scan barcodes consecutively. The user needs to trigger the scanner once and barcodes will be scanned without any further interaction before each scan. This allows for a smoother experience when multiple barcodes need to be scanned consecutively.

tip

Users can enable continuous scanning by holding down the trigger button. This gesture can be disabled (SparkScanViewSettings.holdToScanEnabled).

Preview Behavior

The preview behavior determines how the camera preview behaves when the scanner is not actively scanning.

Behavior	Description
Default	Preview fades away when the scanner is off. This lets the user check important information displayed by the app and reduces battery consumption.
Persistent	Preview remains visible, but darkened, even when the scanner is off. This is useful for scenarios where you want to select a barcode (among many) or need to look through the preview at all times (to ensure the right scan) - especially if used in conjunction with the selection mode On.