Barcode Capture#

Defined in package com.scandit.datacapture.barcode.capture

BarcodeCapture#
class BarcodeCapture : DataCaptureMode

Added in version 6.0.0

Capture mode for single barcode scanning. For MatrixScan-based barcode capture, use BarcodeTracking instead.

Learn more on how to use barcode capture in our Get Started With Barcode Scanning guide.

This capture mode uses the barcode scanning capability. It can not be used together with other capture modes that require the same capabilities, e.g. BarcodeTracking or LabelCapture.

forDataCaptureContext(dataCaptureContext, settings)#
static @NonNull BarcodeCapture forDataCaptureContext(
        @Nullable DataCaptureContext dataCaptureContext,
        @NonNull BarcodeCaptureSettings settings)

Added in version 6.0.0

Construct a new barcode capture mode with the provided context and settings. When the context is not null, the capture mode is automatically added to the context.

fromJson(dataCaptureContext, jsonData)#
static @NonNull BarcodeCapture fromJson(@NonNull DataCaptureContext dataCaptureContext,
        @NonNull String jsonData)

Added in version 6.0.0

Construct a new barcode capture mode with the provided JSON serialization. See Serialization for details. The capture mode is automatically added to the context.

isEnabled#
boolean isEnabled()
void setEnabled(boolean value)

Added in version 6.0.0

Implemented from DataCaptureMode. See DataCaptureMode.isEnabled.

pointOfInterest#
@Nullable PointWithUnit getPointOfInterest()
void setPointOfInterest(@Nullable PointWithUnit value)

Added in version 6.1.0

The point of interest overwriting the point of interest of the data capture view. By default, this overwriting point of interest is not set and the one from the data capture view is used. The overwriting point of interest is used to control the center of attention for the following subsystems:

  • Location selection. When no location selection is set, the point of interest defines the location at which the recognition optimizes for reading barcodes.

  • Rendered viewfinders.

applySettings(settings, whenDone)#
void applySettings(@NonNull BarcodeCaptureSettings settings, @Nullable Runnable whenDone)

Added in version 6.0.0

Asynchronously applies the new settings to the barcode scanner. If the scanner is currently running, the task will complete when the next frame is processed, and will use the new settings for that frame. If the scanner is currently not running, the task will complete as soon as the settings have been stored and won’t wait until the next frame is going to be processed.

applySettings(settings)#
void applySettings(@NonNull BarcodeCaptureSettings settings)

Added in version 6.0.0

Same as applySettings() with the second argument set to null.

feedback#
@NonNull BarcodeCaptureFeedback getFeedback()
void setFeedback(@NonNull BarcodeCaptureFeedback value)

Added in version 6.0.0

Instance of BarcodeCaptureFeedback that is used by the barcode scanner to notify users about Success and Failure events.

The default instance of the Feedback will have both sound and vibration enabled. A default beep sound will be used for the sound.

To change the feedback emitted, the BarcodeCaptureFeedback can be modified as shown below, or a new one can be assigned.

BarcodeCapture barcodeCapture = ...;
barcodeCapture.getFeedback().setSuccess(new Feedback(null, Sound.defaultSound()));
addListener(listener)#
void addListener(@Nullable BarcodeCaptureListener listener)

Added in version 6.0.0

Adds the listener to this barcode capture instance.

In case the same listener is already observing this instance, calling this method will not add the listener again.

removeListener(listener)#
void removeListener(@Nullable BarcodeCaptureListener listener)

Added in version 6.0.0

Removes a previously added listener from this barcode capture instance.

In case the listener is not currently observing this instance, calling this method has no effect.

createRecommendedCameraSettings()#
static @NonNull CameraSettings createRecommendedCameraSettings()

Added in version 6.0.0

Returns the recommended camera settings for use with barcode capture.

dataCaptureContext#
@Nullable DataCaptureContext getDataCaptureContext()

Added in version 6.0.0

Implemented from DataCaptureMode. See DataCaptureMode.dataCaptureContext.

updateFromJson(jsonData)#
void updateFromJson(@NonNull String jsonData)

Added in version 6.0.0

Updates the mode according to a JSON serialization. See Serialization for details.