SparkScan View

Defined in package com.scandit.datacapture.barcode.spark.ui

SparkScanScanningBehavior

Added in version 6.15.0

The capture mode type of the SparkScanView.

SINGLE

Added in version 6.15.0

Barcode capturing session is stopped after each scan.

CONTINUOUS

Added in version 6.15.0

Keeps the barcode capturing session active for longer time.

SparkScanPreviewBehavior

Added in version 6.23.0

The preview behavior type of the SparkScanView.

DEFAULT

Added in version 6.23.0

After a scan with scanning behavior SparkScanScanningBehavior.SINGLE, or stopping scanning with scanning behavior SparkScanScanningBehavior.CONTINUOUS, camera moves to standby state and preview is hidden for maximum efficiency.

PERSISTENT

Added in version 6.23.0

After a scan with scanning behavior SparkScanScanningBehavior.SINGLE, or stopping scanning with scanning behavior SparkScanScanningBehavior.CONTINUOUS, camera stays active and preview is visible for maximum precision.

SparkScanMiniPreviewSize

Added in version 7.0.0

The size of the mini preview in SparkScanView. Used in SparkScanViewSettings.defaultMiniPreviewSize.

REGULAR

Added in version 7.0.0

Regular, smaller size of the mini preview.

EXPANDED

Added in version 7.0.0

Expanded, larger size of the mini preview.

SparkScanViewState

Added in version 7.0.0

The view state of SparkScanView.

INITIAL

Added in version 7.0.0

The initial view state for a few moments after SparkScanView is created.

IDLE

Added in version 7.0.0

SparkScan is displaying only the collapsed capture button.

INACTIVE

Added in version 7.0.0

SparkScan is displaying an expanded capture button, and if the SparkScanPreviewBehavior of the current SparkScanScanningMode is SparkScanPreviewBehavior.PERSISTENT, we are also displaying camera feed through the mini preview but no actual scanning is taking place. This state is reachable after scanning or after a SparkScanViewSettings.inactiveStateTimeout timeout.

ACTIVE

Added in version 7.0.0

We are actively recognising barcodes, mini preview and expanded capture button are visible.

ERROR

Added in version 7.0.0

User returns SparkScanBarcodeFeedback.Error from the SparkScanView.feedbackDelegate. Mini preview is visible with a frozen frame and expanded capture button is visible. If capture button is tapped or after a Error.resumeCapturingDelay timeout is reached we move to ACTIVE state.

SparkScanViewUiListener

interface SparkScanViewUiListener

Added in version 6.16.0

onBarcodeFindButtonTap(view)

fun onBarcodeFindButtonTap(view: SparkScanView)

Added in version 6.26.0

Callback method that can be used to define an action that should be performed when barcode find button is tapped from the toolbar. Called from the main thread.

onBarcodeCountButtonTap(view)

fun onBarcodeCountButtonTap(view: SparkScanView)

Added in version 6.16.0

Callback method that can be used to define an action that should be performed when barcode count button is tapped from the toolbar. Called from the main thread.

onLabelCaptureButtonTap(view)

fun onLabelCaptureButtonTap(view: SparkScanView)

Added in version 7.0.0

Callback method that can be used to define an action that should be performed when label capture button is tapped from the toolbar. Called from the main thread.

onScanningModeChange(newScanningMode)

fun onScanningModeChange(newScanningMode: SparkScanScanningMode)

Added in version 6.20.0

Callback method that will be called when the currently used SparkScanScanningMode changes. Called from the main thread.

onViewStateChanged(newState)

fun onViewStateChanged(newState: SparkScanViewState)

Added in version 7.0.0

Callback method that will be called when SparkScanViewState changes. Called from the main thread.

SparkScanScanningMode

abstract class SparkScanScanningMode

Added in version 6.16.0

The base class for setting a default scanning mode to SparkScanViewSettings. Can be either Target or Default.

Target

class Target : SparkScanScanningMode

Added in version 6.16.0

Target scanning mode. This is meant and optimized to scan codes further away.

Target(scanningBehavior, previewBehavior)

Target(scanningBehavior: SparkScanScanningBehavior,
        previewBehavior: SparkScanPreviewBehavior)

Added in version 6.23.0

Constructs a new target scanning mode with the provided capture mode and preview behavior.

scanningBehavior

val scanningBehavior: SparkScanScanningBehavior

Added in version 6.16.0

The scanning mode provided in the constructor.

previewBehavior

val previewBehavior: SparkScanPreviewBehavior

Added in version 6.23.0

The preview behavior provided in the constructor.

Default

class Default : SparkScanScanningMode

Added in version 6.16.0

This is the standard scanning mode for SparkScan.

Default(scanningBehavior, previewBehavior)

Default(scanningBehavior: SparkScanScanningBehavior,
        previewBehavior: SparkScanPreviewBehavior)

Added in version 6.23.0

Constructs a new default scanning mode with the provided capture mode and preview behavior.

scanningBehavior

val scanningBehavior: SparkScanScanningBehavior

Added in version 6.16.0

The scanning mode provided in the constructor.

previewBehavior

val previewBehavior: SparkScanPreviewBehavior

Added in version 6.23.0

The preview behavior provided in the constructor.

SparkScanCoordinatorLayout

class SparkScanCoordinatorLayout : FrameLayout

Added in version 6.15.0

SparkScanCoordinatorLayout is a FrameLayout.

SparkScanCoordinatorLayout is intended to be used as a container of your layout and where the SparkScanView will be used.

SparkScanCoordinatorLayout()

SparkScanCoordinatorLayout(context: Context)

Added in version 6.15.0

Public constructor of the SparkScanCoordinatorLayout.

SparkScanCoordinatorLayout()

SparkScanCoordinatorLayout(context: Context,
        attrs: AttributeSet?)

Added in version 6.15.0

Public constructor of the SparkScanCoordinatorLayout.

SparkScanCoordinatorLayout()

SparkScanCoordinatorLayout(context: Context,
        attrs: AttributeSet,
        defStyleAttr: Int)

Added in version 6.15.0

Public constructor of the SparkScanCoordinatorLayout.

<com.scandit.datacapture.barcode.spark.ui.SparkScanCoordinatorLayout
    xmlns:android="http://schemas.android.com/apk/res/android"
    android:layout_width="match_parent"
    android:layout_height="match_parent">

    // Your layout goes here

</com.scandit.datacapture.barcode.spark.ui.SparkScanCoordinatorLayout>

SparkScanView

class SparkScanView : RelativeLayout

Added in version 6.15.0

SparkScan comes with a ready-to-use UI and scanning modes that are purpose-built to tackle high-volume scanning at close range. The SparkScanView integrates with any app without requiring app redesign or customization. It includes:

camera preview screen

large-sized scan button

quick access toolbar to adjust scanning settings

onPause()

fun onPause()

Added in version 6.15.0

Function to call on Fragment/Activity onPause callback. You have to call this for the correct functioning of the SparkScanView.

override fun onPause() {
  super.onPause()
  sparkScanView.onPause()
}

onResume()

fun onResume()

Added in version 6.16.0

Function to call on Fragment/Activity onResume callback. You have to call this for the correct functioning of the SparkScanView.

override fun onResume() {
  super.onResume()
  sparkScanView.onResume()
}

feedbackDelegate

var feedbackDelegate: SparkScanFeedbackDelegate?

Added in version 6.23.0

Sets the feedback delegate. If no delegate is set, the default SparkScanBarcodeFeedback.Success feedback is emitted.

hardwareTriggerSupported

val SparkScanView.hardwareTriggerSupported: Boolean

Added in version 6.16.0

Returns whether the device supports listening for hardware button events. This is true for devices with api >= 28.

newInstance(parentView, dataCaptureContext, sparkScan, settings)

fun SparkScanView.newInstance(parentView: View,
        dataCaptureContext: DataCaptureContext,
        sparkScan: SparkScan,
        settings: SparkScanViewSettings): SparkScanView

Added in version 6.15.0

Constructs a new SparkScan view and adds it to the provided parentView. When the settings are provided, those will be used to set the default behaviour and look of the view.

newInstance(parentView, dataCaptureContext, sparkScan)

fun SparkScanView.newInstance(parentView: View,
        dataCaptureContext: DataCaptureContext,
        sparkScan: SparkScan): SparkScanView

Added in version 6.15.0

Constructs a new SparkScan view and adds it to the provided parentView.

sparkScanView = SparkScanView.newInstance(
      rootView, // Preferably SparkScanCoordinatorLayout instance
      dataCaptureContext,
      sparkScan, // SparkScan mode instance
  )

stopScanning(callback)

fun stopScanning(callback: Callback<Boolean>)

Added in version 7.6.0

Stops the scanning process and turns the camera off. The provided callback will be invoked on the main thread after the switching off operation of the camera is completed. You wouldn’t normally need to use this method. If you want to programmatically control the scanning process, use pauseScanning() and startScanning() instead.

startScanning()

fun startScanning()

Added in version 6.15.0

Starts the scanning process. You can call this method if you want to trigger the scanning process without any user interaction.

pauseScanning()

fun pauseScanning()

Added in version 6.15.0

Pauses the scanning process. You can call this method if you want to trigger pausing the scanning process without any user interaction.

setListener(listener)

fun setListener(listener: SparkScanViewUiListener?)

Added in version 6.16.0

Sets the listener which is called whenever a barcode find button or barcode count button is tapped from the toolbar.

showToast(text)

fun showToast(text: String)

Added in version 6.18.0

Shows a toast with text inside the mini preview.

getScanningMode()

fun getScanningMode(): SparkScanScanningMode

Added in version 6.20.0

Returns the currently used SparkScanScanningMode.

setTriggerButtonImage(resourceId)

fun setTriggerButtonImage(resourceId: Int)

Added in version 7.0.0

Sets the resource to use for the trigger button image.

barcodeCountButtonVisible

var barcodeCountButtonVisible: Boolean

Added in version 6.16.0

Indicates whether the barcode count button should be shown to the user.

Default is false.

barcodeFindButtonVisible

var barcodeFindButtonVisible: Boolean

Added in version 6.26.0

Indicates whether the barcode find button should be shown to the user.

Default is false.

labelCaptureButtonVisible

var labelCaptureButtonVisible: Boolean

Added in version 7.0.0

Indicates whether the label capture button should be shown to the user.

Default is false.

targetModeButtonVisible

var targetModeButtonVisible: Boolean

Added in version 6.16.0

Indicates whether the target mode button should be shown to the user.

Default is false.

scanningBehaviorButtonVisible

var scanningBehaviorButtonVisible: Boolean

Added in version 6.15.0

Indicates whether the scanning behavior button should be shown to the user.

Default is false.

zoomSwitchControlVisible

var zoomSwitchControlVisible: Boolean

Added in version 6.18.0

Indicates whether the zoom switch control should be shown to the user.

Default is true.

triggerButtonVisible

var triggerButtonVisible: Boolean

Added in version 7.0.0

Indicates whether the trigger button should be shown to the user.

Default is true.

previewSizeControlVisible

var previewSizeControlVisible: Boolean

Added in version 6.23.0

Indicates whether the mini preview size control should be shown to the user.

Default is true.

torchControlVisible

var torchControlVisible: Boolean

Added in version 7.0.0

Indicates whether the torch control should be shown to the user.

Default is true.

Note

If SparkScanViewSettings.defaultTorchState is set to TorchState.AUTO, torch control is hidden.

previewCloseControlVisible

var previewCloseControlVisible: Boolean

Added in version 7.0.0

Indicates whether the mini preview close control should be shown to the user.

Default is true.

cameraSwitchButtonVisible

var cameraSwitchButtonVisible: Boolean

Added in version 6.24.0

Indicates whether the camera switch button should be shown to the user.

Default is false.

Note

This API is still in beta and may change in future versions of Scandit Data Capture SDK.

triggerButtonCollapsedColor

var triggerButtonCollapsedColor: Int?

Added in version 7.0.0

Sets the background color of the trigger button when button is collapsed.

triggerButtonExpandedColor

var triggerButtonExpandedColor: Int?

Added in version 7.0.0

Sets the background color of the trigger button when button is expanded.

triggerButtonAnimationColor

var triggerButtonAnimationColor: Int?

Added in version 7.0.0

Sets the color of the pulsing animation around the trigger button, which is shown when the scanner is active.

triggerButtonTintColor

var triggerButtonTintColor: Int?

Added in version 7.0.0

Sets the trigger button tint color.

toolbarBackgroundColor

var toolbarBackgroundColor: Int?

Added in version 6.16.0

Sets the toolbar background color.

Default is null.

toolbarIconActiveTintColor

var toolbarIconActiveTintColor: Int?

Added in version 6.16.0

Sets the toolbar icon active color.

Default is null.

toolbarIconInactiveTintColor

var toolbarIconInactiveTintColor: Int?

Added in version 6.16.0

Sets the toolbar icon inactive color.

Default is null.

triggerButtonImage

var triggerButtonImage: Bitmap?

Added in version 7.0.0

The image displayed in the trigger button.

Note

Troubleshooting: Buttons Not Working With Navigation Header

When using the SparkScanView component with React Navigation and headerShown: true, you may encounter an issue where the Buttons within your SparkScanView don’t respond to touch events. This is a known issue with React Navigation’s header implementation.

The Issue

The navigation header can interfere with touch event handling for components rendered within certain custom views like SparkScanView. While the buttons appear to be functioning visually, their onPress events do not trigger when the screen includes a header.

Solution

Try this workaround if you encounter this issue:

Use TouchableOpacity instead of Button

<TouchableOpacity
  onPressIn={() => handleButtonPress()}>
  <Text>Scan</Text>
</TouchableOpacity>

or

<TouchableOpacity
  onPressOut={() => handleButtonPress()}>
  <Text>Scan</Text>
</TouchableOpacity>

Ensure you’re importing TouchableOpacity from ‘react-native’

Some users have found that using the TouchableOpacity component from ‘react-native-gesture-handler’ causes issues, while the one from ‘react-native’ works correctly.