Barcode Find

Defined in namespace Scandit.DataCapture.Barcode.Find.Capture

BarcodeFind

class BarcodeFind : IDataCaptureMode

Added in version 6.21.0

Capture mode that implements BarcodeFind.

This capture mode uses the barcode scanning and tracking capabilities. It cannot be used together with other capture modes that require the same capabilities, e.g. BarcodeCapture.

BarcodeFind()

BarcodeFind(BarcodeFindSettings settings)

Added in version 6.21.0

Construct a new BarcodeFind mode with the provided settings.

RecommendedCameraSettings

static CameraSettings RecommendedCameraSettings { get; }

Added in version 6.21.0

Returns the recommended camera settings for use with barcode find.

Enabled

bool Enabled { get;set; }

Added in version 6.21.0

This flag indicates whether the BarcodeFind mode is currently processing frames to recognise barcodes.

Changing this property from false to true causes the connected BarcodeFindView to start its scanning flow.

Changing this property from true to false causes the connected BarcodeFindView to stop its scanning flow and go to idle mode.

ApplySettingsAsync()

Task ApplySettingsAsync(BarcodeFindSettings settings)

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

Context

DataCaptureContext Context { get; }

Added in version 6.21.0

The context this mode is attached to. When the data capture mode is not attached to a context, null is returned.

AddListener()

void AddListener(IBarcodeFindListener listener)

Added in version 6.21.0

Adds the listener to this BarcodeFind instance.

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

RemoveListener()

void RemoveListener(IBarcodeFindListener listener)

Added in version 6.21.0

Removes a previously added listener from this BarcodeFind instance.

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

SetItemList()

void SetItemList(ICollection<BarcodeFindItem> items)

Added in version 6.21.0

Sets the list of items to search. This method runs asynchronously.

Start()

void Start()

Added in version 6.21.0

Starts or resumes the search process.

Pause()

void Pause()

Added in version 6.21.0

Pauses the search process.

Stop()

void Stop()

Added in version 6.21.0

Stops the search process and clears the list of found items. If this is not called, the BarcodeFind instance will remember all found items.

Feedback

BarcodeFindFeedback Feedback { get;set; }

Added in version 6.21.0

Instance of BarcodeFindFeedback that is used by the barcode scanner to notify users about Found events.

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

SearchStarted

event EventHandler SearchStarted

Added in version 6.21.0

Occurs whenever the search process has been started.

This method is invoked from a recognition internal thread. To perform UI work, you must dispatch to the main thread first.

SearchPaused

event EventHandler<BarcodeFindEventArgs> SearchPaused

Added in version 6.21.0

Occurs whenever the search process has been paused. The BarcodeFindEventArgs.FoundItems property contains all the items found on the last processed camera frame.

This method is invoked from a recognition internal thread. To perform UI work, you must dispatch to the main thread first.

SearchStopped

event EventHandler<BarcodeFindEventArgs> SearchStopped

Added in version 6.21.0

Occurs whenever the search process has been stopped. The BarcodeFindEventArgs.FoundItems property contains all the items found since the start of the process.

This method is invoked from a recognition internal thread. To perform UI work, you must dispatch to the main thread first.

SetTransformer()

void SetTransformer(IBarcodeFindTransformer transformer)

Added in version 6.23.0

Sets a transformer for this instance of BarcodeFind.