Barcode Capture#

Defined under the namespace Scandit.Datacapture.Barcode

BarcodeCapture#
class BarcodeCapture : DataCaptureMode

Added in version 6.1.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 cannot be used together with other capture modes that require the same capabilities, e.g. BarcodeTracking.

forContext(context, settings)#
static forContext(context: DataCaptureContext | null,
        settings: BarcodeCaptureSettings): BarcodeCapture

Added in version 6.1.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.

isEnabled#
isEnabled: boolean

Added in version 6.1.0

Implemented from DataCaptureMode. See DataCaptureMode.isEnabled.

applySettings(settings)#
applySettings(settings: BarcodeCaptureSettings): Promise<void>

Added in version 6.1.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.

feedback#
feedback: BarcodeCaptureFeedback

Added in version 6.1.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.

const barcodeCapture = ...
const feedback = Scandit.BarcodeCaptureFeedback.defaultFeedback
feedback.success = new Scandit.Feedback(Scandit.Vibration.defaultVibration, null)
barcodeCapture.feedback = feedback
addListener(listener)#
addListener(listener: BarcodeCaptureListener): void

Added in version 6.1.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)#
removeListener(listener: BarcodeCaptureListener): void

Added in version 6.1.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.

recommendedCameraSettings()#
static get recommendedCameraSettings(): CameraSettings

Added in version 6.1.0

Returns the recommended camera settings for use with barcode capture.

context#
get context(): DataCaptureContext | null

Added in version 6.1.0

Implemented from DataCaptureMode. See DataCaptureMode.context.