Barcode Find
Defined in package com.scandit.datacapture.barcode.find
- BarcodeFind
class BarcodeFind : DataCaptureMode
Added in version 8.6.0
Capture mode that implements BarcodeFind.
- BarcodeFind()
BarcodeFind(settings: BarcodeFindSettings)
Added in version 8.6.0
Constructs a new BarcodeFind mode with the provided settings.
- forContext(dataCaptureContext, settings)
fun BarcodeFind.forContext(dataCaptureContext: DataCaptureContext, settings: BarcodeFindSettings): BarcodeFind
Added in version 8.6.0
Constructs a new BarcodeFind mode for the provided context and settings.
- isEnabled
var isEnabled:
BooleanAdded in version 8.6.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.
- applySettings(settings)
fun applySettings(settings: BarcodeFindSettings)
Added in version 8.6.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.
- dataCaptureContext
val dataCaptureContext: DataCaptureContext?
Added in version 8.6.0
The context this mode is attached to. When the data capture mode is not attached to a context, null is returned.
- addListener(listener)
fun addListener(listener: BarcodeFindListener)
Added in version 8.6.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(listener)
fun removeListener(listener: BarcodeFindListener)
Added in version 8.6.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(items)
fun setItemList(items: Set<BarcodeFindItem>)
Added in version 8.6.0
Sets the list of items to search. This method runs asynchronously.
- start()
fun start()Added in version 8.6.0
Starts or resumes the search process.
- pause()
fun pause()Added in version 8.6.0
Pauses the search process.
- stop()
fun stop()Added in version 8.6.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
var feedback: BarcodeFindFeedback
Added in version 8.6.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.
- setBarcodeTransformer(transformer)
fun setBarcodeTransformer(transformer: BarcodeFindTransformer?)
Added in version 8.6.0
Sets a transformer for this instance of BarcodeFind.
- BarcodeFindEvent
class BarcodeFindEventAdded in version 8.6.0
Event emitted by the
BarcodeFind.eventsFlow(KMP only). Reifies the BarcodeFindListener callbacks into an observable stream.
- Started
class Started : BarcodeFindEvent
Added in version 8.6.0
Emitted when the search starts.
- Paused
class Paused : BarcodeFindEvent
Added in version 8.6.0
Emitted when the search is paused.
- Paused()
Paused(foundItems: Set<BarcodeFindItem>)
Added in version 8.6.0
Creates the event with the items found so far.
- foundItems
val foundItems: Set<BarcodeFindItem>
Added in version 8.6.0
The items found so far.
- Stopped
class Stopped : BarcodeFindEvent
Added in version 8.6.0
Emitted when the search is stopped.
- Stopped()
Stopped(foundItems: Set<BarcodeFindItem>)
Added in version 8.6.0
Creates the event with the items found so far.
- foundItems
val foundItems: Set<BarcodeFindItem>
Added in version 8.6.0
The items found so far.