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.
- SparkScanViewHandMode
Added in version 6.15.0
The hand mode type of the SparkScanView.
- RIGHT
Added in version 6.15.0
Optimizes the layout for right-hand use of the SparkScanView.
- LEFT
Added in version 6.15.0
Optimizes the layout for left-hand use of the SparkScanView.
- SparkScanScanningPrecision
Added in version 6.19.0
The scanning precision type of the SparkScanView.
- DEFAULT
Added in version 6.19.0
Default precision. Depending on the configured scanning mode and behavior, it results in the following behaviors:
Tapping the trigger button starts the camera and the scanning process.
A barcode is scanned as soon as it is visible on the camera frame.
After a successful scan, the scanning process is stopped, and the camera is frozen on the last frame.
Tapping the trigger button starts the camera and the scanning process.
A barcode is scanned after pointing the viewfinder at it for a short time.
After a successful scan, the scanning process is stopped, and the camera is frozen on the last frame.
Tapping the trigger button starts the camera and the scanning process.
A barcode is scanned as soon as it is visible on the camera frame.
Camera and scanning process keep running until the user taps the trigger button, or the SparkScanViewSettings.continuousCaptureTimeout expires.
Tapping the trigger button starts the camera and the scanning process.
A barcode is scanned after pointing the viewfinder at it for a short time.
Camera and scanning process keep running until the user taps the trigger button, or the SparkScanViewSettings.continuousCaptureTimeout expires.
- ACCURATE
Added in version 6.19.0
Accurate precision. Depending on the configured scanning mode and behavior, it results in the following behaviors:
Expanding the trigger button starts the camera, and tapping it starts the scanning process.
A barcode is scanned after pointing the viewfinder at it.
After a successful scan, the scanning process is stopped, but the camera keeps running.
Tapping the trigger button starts the camera and the scanning process.
A barcode is scanned after pointing the viewfinder at it and tapping the trigger button.
Camera and scanning process keep running until the trigger button is collapsed.
Expanding the trigger button starts the camera, and tapping it starts the scanning process.
A barcode is scanned after pointing the viewfinder at it.
Camera and scanning process keep running until the user taps the trigger button, or the SparkScanViewSettings.continuousCaptureTimeout expires.
Expanding the trigger button starts the camera, and tapping it starts the scanning process.
A barcode is scanned after pointing the viewfinder at it for a short time.
Camera and scanning process keep running until the user taps the trigger button, or the SparkScanViewSettings.continuousCaptureTimeout expires.
- SparkScanViewUiListener
interface SparkScanViewUiListener
Added in version 6.16.0
- onFastFindButtonTap(view)
void
onFastFindButtonTap(@NonNull SparkScanView view)Added in version 6.16.0
Callback method that can be used to define an action that should be performed when fast find button is tapped from the toolbar. Called from the main thread.
- onBarcodeCountButtonTap(view)
void
onBarcodeCountButtonTap(@NonNull SparkScanView view)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.
- 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()
Target(SparkScanScanningBehavior scanningBehavior, SparkScanScanningPrecision scanningPrecision)
Added in version 6.16.0
Constructs a new target scanning mode with the provided capture mode and scanning precision.
- scanningBehavior
SparkScanScanningBehavior getScanningBehavior()
Added in version 6.16.0
The scanning mode provided in the constructor.
- scanningPrecision
SparkScanScanningPrecision getScanningPrecision()
Added in version 6.19.0
The scanning precision provided in the constructor.
- Default
class Default : SparkScanScanningMode
Added in version 6.16.0
This is the standard scanning mode for SparkScan.
- Default()
Default(SparkScanScanningBehavior scanningBehavior, SparkScanScanningPrecision scanningPrecision)
Added in version 6.16.0
Constructs a new default scanning mode with the provided capture mode and scanning precision.
- scanningBehavior
SparkScanScanningBehavior getScanningBehavior()
Added in version 6.16.0
The scanning mode provided in the constructor.
- scanningPrecision
SparkScanScanningPrecision getScanningPrecision()
Added in version 6.19.0
The scanning precision 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(@NonNull Context context)
Added in version 6.15.0
Public constructor of the SparkScanCoordinatorLayout.
- SparkScanCoordinatorLayout()
SparkScanCoordinatorLayout(@NonNull Context context, @Nullable
AttributeSet
attrs)Added in version 6.15.0
Public constructor of the SparkScanCoordinatorLayout.
- SparkScanCoordinatorLayout()
SparkScanCoordinatorLayout(@NonNull Context context, @NonNull
AttributeSet
attrs,int
defStyleAttr)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()
void
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()
void
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() }
- emitFeedback(feedback)
void
emitFeedback(@NonNull SparkScanViewFeedback feedback)Added in version 6.16.0
Displays the SparkScanViewFeedback feedback and emits a SparkScanFeedback based on the feedback type.
- hardwareTriggerSupported
boolean
getHardwareTriggerSupported()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)
static @NonNull SparkScanView newInstance(@NonNull View parentView, @NonNull DataCaptureContext dataCaptureContext, @NonNull SparkScan sparkScan, @NonNull SparkScanViewSettings settings)
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)
static @NonNull SparkScanView newInstance(@NonNull View parentView, @NonNull DataCaptureContext dataCaptureContext, @NonNull SparkScan sparkScan)
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 )
- startScanning()
void
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()
void
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)
void
setListener(@Nullable SparkScanViewUiListener listener)Added in version 6.16.0
Sets the listener which is called whenever a fast find button or barcode count button is tapped from the toolbar.
- showToast(text)
void
showToast(@NonNull String text)Added in version 6.18.0
Shows a toast with text inside the capture button.
- shouldShowScanAreaGuides
boolean
getShouldShowScanAreaGuides()void
setShouldShowScanAreaGuides(boolean
value)Added in version 6.16.0
Whether to show scan area guides on top of the preview. This property is useful during development to visualize the current scan areas on screen. It is not meant to be used for production. By default this property is false.
- brush
@NonNull Brush getBrush()
void
setBrush(@NonNull Brush value)Added in version 6.16.0
The brush used for visualizing captured barcodes in the UI. To turn off drawing of locations, set the brush to use both a transparent fill and stroke color. By default, the brush has a transparent fill color, a white stroke color, and a stroke width of 1.
- barcodeCountButtonVisible
boolean
getBarcodeCountButtonVisible()void
setBarcodeCountButtonVisible(boolean
value)Added in version 6.16.0
Indicates whether the barcode count button should be shown to the user.
Default is false.
- fastFindButtonVisible
boolean
getFastFindButtonVisible()void
setFastFindButtonVisible(boolean
value)Added in version 6.16.0
Indicates whether the fast find button should be shown to the user.
Default is false.
- targetModeButtonVisible
boolean
getTargetModeButtonVisible()void
setTargetModeButtonVisible(boolean
value)Added in version 6.16.0
Indicates whether the target mode button should be shown to the user.
Default is true.
- scanningBehaviorButtonVisible
boolean
getScanningBehaviorButtonVisible()void
setScanningBehaviorButtonVisible(boolean
value)Added in version 6.15.0
Indicates whether the scanning behavior button should be shown to the user.
Default is true.
- torchButtonVisible
boolean
getTorchButtonVisible()void
setTorchButtonVisible(boolean
value)Added in version 6.15.0
Indicates whether the torch button should be shown to the user.
Default is true.
- soundModeButtonVisible
boolean
getSoundModeButtonVisible()void
setSoundModeButtonVisible(boolean
value)Added in version 6.16.0
Indicates whether the enable sound button should be shown to the user.
Default is true.
- hapticModeButtonVisible
boolean
getHapticModeButtonVisible()void
setHapticModeButtonVisible(boolean
value)Added in version 6.16.0
Indicates whether the enable haptic button should be shown to the user.
Default is true.
- handModeButtonVisible
boolean
getHandModeButtonVisible()void
setHandModeButtonVisible(boolean
value)Added in version 6.15.0
Indicates whether the hand mode button should be shown to the user.
Default is true.
- zoomSwitchControlVisible
boolean
getZoomSwitchControlVisible()void
setZoomSwitchControlVisible(boolean
value)Added in version 6.18.0
Indicates whether the zoom switch control should be shown to the user.
Default is true.
- stopCapturingText
@Nullable String getStopCapturingText()
void
setStopCapturingText(@Nullable String value)Added in version 6.15.0
Sets the default text to display in the button for the stop capturing action.
Default is null.
- startCapturingText
@Nullable String getStartCapturingText()
void
setStartCapturingText(@Nullable String value)Added in version 6.15.0
Sets the default text to display in the button for the start capturing action.
Default is null.
- resumeCapturingText
@Nullable String getResumeCapturingText()
void
setResumeCapturingText(@Nullable String value)Added in version 6.15.0
Sets the default text to display in the button for the resume capturing action.
Default is null.
- scanningCapturingText
@Nullable String getScanningCapturingText()
void
setScanningCapturingText(@Nullable String value)Added in version 6.16.0
Sets the default text to display in the button when scanning in SparkScanScanningBehavior.SINGLE.
Default is null.
- captureButtonBackgroundColor
@Nullable Integer getCaptureButtonBackgroundColor()
void
setCaptureButtonBackgroundColor(@Nullable Integer value)Added in version 6.15.0
Sets the background color of the capture button.
Default is null.
- captureButtonActiveBackgroundColor
@Nullable Integer getCaptureButtonActiveBackgroundColor()
void
setCaptureButtonActiveBackgroundColor( @Nullable Integer value)Added in version 6.16.0
Sets the background color of the capture button when scanning.
Default is null.
- captureButtonTintColor
@Nullable Integer getCaptureButtonTintColor()
void
setCaptureButtonTintColor(@Nullable Integer value)Added in version 6.16.0
Sets the capture button icon and text color.
Default is null.
- toolbarBackgroundColor
@Nullable Integer getToolbarBackgroundColor()
void
setToolbarBackgroundColor(@Nullable Integer value)Added in version 6.16.0
Sets the toolbar background color.
Default is null.
- toolbarIconActiveTintColor
@Nullable Integer getToolbarIconActiveTintColor()
void
setToolbarIconActiveTintColor(@Nullable Integer value)Added in version 6.16.0
Sets the toolbar icon active color.
Default is null.
- toolbarIconInactiveTintColor
@Nullable Integer getToolbarIconInactiveTintColor()
void
setToolbarIconInactiveTintColor(@Nullable Integer value)Added in version 6.16.0
Sets the toolbar icon inactive color.
Default is null.
- targetModeHintText
@Nullable String getTargetModeHintText()
void
setTargetModeHintText(@Nullable String value)Added in version 6.18.0
Sets the target mode hint text.
Default is null.
- shouldShowTargetModeHint
boolean
getShouldShowTargetModeHint()void
setShouldShowTargetModeHint(boolean
value)Added in version 6.18.0
Indicates whether hints in target mode should be shown to the user.
Default is true.