Barcode AR

Defined in framework ScanditBarcodeCapture

BarcodeAr

open class BarcodeAr : NSObject

Added in version 7.1.0

Capture mode that implements Barcode AR.

init

convenience init(context: DataCaptureContext?, settings: BarcodeArSettings)

Added in version 7.1.0

Construct a new BarcodeAr instance with the provided settings.

feedback

open var feedback: BarcodeArFeedback { get, set }

Added in version 7.1.0

Instance of BarcodeArFeedback that is used by the barcode scanner to notify users about Ar 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 7.1.0

Returns the recommended camera settings for use with Barcode AR.

apply

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

Added in version 7.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: BarcodeArSettings) async -> Void

Added in version 7.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 BarcodeArListener) -> Void

Added in version 7.1.0

Adds a listener to receive Barcode AR events.

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 BarcodeArListener) -> Void

Added in version 7.1.0

Removes a previously added listener from this BarcodeAr instance.

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

setBarcodeFilter

open func setBarcodeFilter(_ filter: (any BarcodeArFilter)?) -> Void

Added in version 8.1.0

Sets a filter that determines which barcodes should be visible in the BarcodeArSession.

Pass null to remove the filter and show all barcodes.

See BarcodeArFilter for details on implementing a custom filter.