Barcode Find
Defined in framework ScanditBarcodeCapture
- BarcodeFind
open class BarcodeFind : NSObject
Added in version 6.18.0
Capture mode that implements BarcodeFind.
- init
init(settings: BarcodeFindSettings)
Added in version 6.18.0
Construct a new BarcodeFind mode with the provided settings.
- recommendedCameraSettings
open class var recommendedCameraSettings: CameraSettings { get }
Added in version 6.18.0
Returns the recommended camera settings for use with barcode find.
- isEnabled
open var isEnabled:
Bool{ get, set }Added in version 6.18.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.
- apply
open func apply(_ settings: BarcodeFindSettings, completionHandler: (@Sendable () ->
Void)? = nil) ->VoidAdded in version 6.18.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.
- apply
open func apply(_ settings: BarcodeFindSettings) async ->
VoidAdded in version 6.18.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
open var context: DataCaptureContext? { get }
Added in version 6.18.0
The context this mode is attached to. When the data capture mode is not attached to a context, null is returned.
- addListener
open func addListener(_ listener: any BarcodeFindListener) ->
VoidAdded in version 6.18.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
open func removeListener(_ listener: any BarcodeFindListener) ->
VoidAdded in version 6.18.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
open func setItemList(_ items: Set<BarcodeFindItem>) ->
VoidAdded in version 6.18.0
Sets the list of items to search. This method runs asynchronously.
- start
open func start() ->
VoidAdded in version 6.18.0
Starts or resumes the search process.
- pause
open func pause() ->
VoidAdded in version 6.18.0
Pauses the search process.
- stop
open func stop() ->
VoidAdded in version 6.18.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
open var feedback: BarcodeFindFeedback { get, set }
Added in version 6.18.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
open func setBarcodeTransformer(_ barcodeTransformer: any BarcodeFindTransformer) ->
VoidAdded in version 6.21.0
Sets a transformer for this instance of BarcodeFind.