Barcode Sequence

Defined in framework ScanditBarcodeCapture

BarcodeSequence

open class BarcodeSequence : NSObject, DataCaptureMode

Added in version 8.1.0

Capture mode that implements BarcodeSequence.

init

convenience init(context: DataCaptureContext, settings: BarcodeSequenceSettings)

Added in version 8.1.0

Constructs a new Barcode Sequence mode with the provided context and settings. When the context is not nil, the capture mode is automatically added to the context.

isEnabled

open var isEnabled: Bool { get, set }

Added in version 8.1.0

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

context

open var context: DataCaptureContext? { get }

Added in version 8.1.0

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

feedback

open var feedback: BarcodeSequenceFeedback { get, set }

Added in version 8.1.0

Instance of BarcodeSequenceFeedback that is used by the barcode scanner to notify users about sequence events.

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

recommendedCameraSettings

open class var recommendedCameraSettings: CameraSettings { get }

Added in version 8.1.0

Returns the recommended camera settings for use with Barcode Sequence.

apply

open func apply(_ settings: BarcodeSequenceSettings, completionHandler: (@Sendable () -> Void)? = nil) -> Void

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

apply

open func apply(_ settings: BarcodeSequenceSettings) async -> Void

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

addListener

open func addListener(_ listener: any BarcodeSequenceListener) -> Void

Added in version 8.1.0

Adds the listener to this BarcodeSequence instance.

In case the same listener is already observing this instance, calling this method will not add the listener again. The listener is stored using a weak reference and must thus be retained by the caller for it to not go out of scope.

removeListener

open func removeListener(_ listener: any BarcodeSequenceListener) -> Void

Added in version 8.1.0

Removes a previously added listener from this BarcodeSequence instance.

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