DataScannerViewController

loadView

loadView(): Promise<void>

@MainActor override dynamic func loadView()

Creates the view that the controller manages.

removeFromParent

removeFromParent(): Promise<void>

@MainActor override dynamic func removeFromParent()

viewDidDisappear

viewDidDisappear(animated: boolean): Promise<void>

@MainActor override dynamic func viewDidDisappear(_ animated: Bool)

Performs some action after the view disappears. - Parameter animated: A Boolean value that indicates whether the view disappears using an animation.

viewDidLoad

viewDidLoad(): Promise<void>

@MainActor override dynamic func viewDidLoad()

Performs some action after the system loads the view into memory.

viewWillAppear

viewWillAppear(animated: boolean): Promise<void>

@MainActor override dynamic func viewWillAppear(_ animated: Bool)

Performs some action before the view appears. - Parameter animated: A Boolean value that indicates whether the view will appear using an animation.

init

static init(recognizedDataTypes: Array<DataScannerViewController_RecognizedDataType>, qualityLevel?: DataScannerViewController_QualityLevel, recognizesMultipleItems?: boolean, isHighFrameRateTrackingEnabled?: boolean, isPinchToZoomEnabled?: boolean, isGuidanceEnabled?: boolean, isHighlightingEnabled?: boolean): Promise<DataScannerViewController>

@MainActor init(recognizedDataTypes: Set<DataScannerViewController.RecognizedDataType>, qualityLevel: DataScannerViewController.QualityLevel = .balanced, recognizesMultipleItems: Bool = false, isHighFrameRateTrackingEnabled: Bool = true, isPinchToZoomEnabled: Bool = true, isGuidanceEnabled: Bool = true, isHighlightingEnabled: Bool = false)

Creates a scanner for finding data, such as text and machine-readable codes, in the camera’s live video. - Parameter recognizedDataTypes: The types of data that the data scanner identifies in the live video. - Parameter qualityLevel: The level of resolution to scan that depends on the size of the items. - Parameter recognizesMultipleItems: A Boolean value that indicates whether the scanner identifies all items in the live video. - Parameter isHighFrameRateTrackingEnabled: A Boolean value that determines the frequency that the scanner updates the geometry of recognized items. - Parameter isPinchToZoomEnabled: A Boolean value that indicates whether people can use a two-finger pinch-to-zoom gesture. - Parameter isGuidanceEnabled: A Boolean value that indicates whether the scanner provides help to a person when selecting items. - Parameter isHighlightingEnabled: A Boolean value that indicates whether the scanner displays highlights around recognized items.

recognizedDataTypes

get recognizedDataTypes(): Promise<Array<DataScannerViewController_RecognizedDataType>>

@MainActor final let recognizedDataTypes: Set<DataScannerViewController.RecognizedDataType>

The types of data that the data scanner identifies in the live video.

overlayContainerView

get overlayContainerView(): Promise<_UIKit_UIView>

@MainActor var overlayContainerView: UIView { get }

A view that the data scanner displays over its view without interfering with the Live Text interface. Optionally, add custom highlights to this view that doesn’t interfere with hit-testing or the guidance objects. If you want to add interface objects above the highlights, add those objects as subviews of the <doc://com.apple.documentation/documentation/uikit/uiviewcontroller/1621460-view> property.

isScanning

get isScanning(): Promise<boolean>

@MainActor var isScanning: Bool { get }

A Boolean value that indicates whether the data scanner is actively looking for items.

zoomFactor

get zoomFactor(): Promise<number>

@MainActor var zoomFactor: Double { get set }

The zoom factor for the live video in the camera. Set this property to a value between the ``DataScannerViewController/minZoomFactor`` and ``DataScannerViewController/maxZoomFactor`` properties.

zoomFactor

setZoomFactor(value: number): Promise<void>

@MainActor var zoomFactor: Double { get set }

The zoom factor for the live video in the camera. Set this property to a value between the ``DataScannerViewController/minZoomFactor`` and ``DataScannerViewController/maxZoomFactor`` properties.

isAvailable

static get isAvailable(): Promise<boolean>

@MainActor class var isAvailable: Bool { get }

A Boolean value that indicates whether a person grants your app access to the camera and doesn’t have any restrictions to using the camera. For example, this property may be `false` if a person has Screen Time restrictions.

isSupported

static get isSupported(): Promise<boolean>

@MainActor class var isSupported: Bool { get }

A Boolean value that indicates whether the device supports data scanning. For this property to be `true`, the device must have the A12 Bionic chip or later. This property is `false` for apps running in visionOS. - Important: If your app requires data scanning for its core functionality, you can make your app available only on devices that support data scanning. Add the <doc://com.apple.documentation/documentation/bundleresources/information_property_list/uirequireddevicecapabilities> key to your app’s information property list and include the `iphone-ipad-minimum-performance-a12` subkey in the array of device capabilities.

capturePhoto

capturePhoto(): Promise<_UIKit_UIImage>

@MainActor func capturePhoto() async throws -> UIImage

Captures a high-resolution photo of the camera’s live video. - Returns: An image of the live video.

qualityLevel

get qualityLevel(): Promise<DataScannerViewController_QualityLevel>

@MainActor final let qualityLevel: DataScannerViewController.QualityLevel

The resolution that the scanner uses to find data. The default value is ``DataScannerViewController/QualityLevel-swift.enum/balanced``. To increase recognition speed for larger items, you can set this property to ``DataScannerViewController/QualityLevel-swift.enum/fast``. For smaller items, you can set this property to ``DataScannerViewController/QualityLevel-swift.enum/accurate`` but it may impact the recognition speed.

stopScanning

stopScanning(): Promise<void>

@MainActor func stopScanning()

Stops scanning the camera’s live video for data. This method removes all items from the ``DataScannerViewController/recognizedItems`` property.

maxZoomFactor

get maxZoomFactor(): Promise<number>

@MainActor var maxZoomFactor: Double { get }

The maximum zoom factor that the camera supports.

minZoomFactor

get minZoomFactor(): Promise<number>

@MainActor var minZoomFactor: Double { get }

The minimum zoom factor that the camera supports.

startScanning

startScanning(): Promise<void>

@MainActor func startScanning() throws

Starts scanning the camera’s live video for data.

recognizedItems

get recognizedItems(): Promise<SDKSequence<Array<RecognizedItem>>>

@MainActor var recognizedItems: AsyncStream<[RecognizedItem]> { get }

An asynchronous array of items that the data scanner currently recognizes in the camera’s live video. You can use this property instead of the ``DataScannerViewControllerDelegate`` protocol methods to track the recognized items in real time. To get the changes between arrays, use the <doc://com.apple.documentation/documentation/swift/array/difference(from:)> method. For more information on asynchronous streams, see <doc://com.apple.documentation/documentation/swift/concurrency>. Text items in this array appear in the reading order of the language and region.

regionOfInterest

get regionOfInterest(): Promise<({ x: number; y: number; width: number; height: number }) | null>

@MainActor var regionOfInterest: CGRect? { get set }

The area of the live video in view coordinates that the data scanner searches for items. If you add interface objects to the live video (using the ``DataScannerViewController/overlayContainerView`` property) that might hide items from a person, set this property to restrict the scanning area. The default value is the bounds of the view.

regionOfInterest

setRegionOfInterest(value?: ({ x: number; y: number; width: number; height: number }) | null): Promise<void>

@MainActor var regionOfInterest: CGRect? { get set }

The area of the live video in view coordinates that the data scanner searches for items. If you add interface objects to the live video (using the ``DataScannerViewController/overlayContainerView`` property) that might hide items from a person, set this property to restrict the scanning area. The default value is the bounds of the view.

isGuidanceEnabled

get isGuidanceEnabled(): Promise<boolean>

@MainActor final let isGuidanceEnabled: Bool

A Boolean value that indicates whether the scanner provides help to a person when selecting items. The guidance text, such as “Slow Down,” appears over the live video. The default value for this property is `true`.

isPinchToZoomEnabled

get isPinchToZoomEnabled(): Promise<boolean>

@MainActor final let isPinchToZoomEnabled: Bool

A Boolean value that indicates whether people can use a two-finger pinch-to-zoom gesture. The default value is `true`.

isHighlightingEnabled

get isHighlightingEnabled(): Promise<boolean>

@MainActor final let isHighlightingEnabled: Bool

A Boolean value that indicates whether the scanner displays highlights around recognized items. The default value is `false`.

recognizesMultipleItems

get recognizesMultipleItems(): Promise<boolean>

@MainActor final let recognizesMultipleItems: Bool

A Boolean value that indicates whether the scanner should identify all items in the live video. If `true`, the scanner finds all items in the live video. If `false`, the scanner finds only the item closest to a person’s point of interest. The point of interest is the middle of the view by default or where a person taps in the live video. The default value is `false`.

isHighFrameRateTrackingEnabled

get isHighFrameRateTrackingEnabled(): Promise<boolean>

@MainActor final let isHighFrameRateTrackingEnabled: Bool

A Boolean value that determines the frequency at which the scanner updates the geometry of recognized items. If `true`, the scanner updates the geometry of items more frequently allowing your app to closely track recognized items. If you don’t track items in the live video, set this property to `false`. The default value is `true`.

supportedTextRecognitionLanguages

static get supportedTextRecognitionLanguages(): Promise<Array<string>>

@MainActor class var supportedTextRecognitionLanguages: [String] { get }

The identifiers for the languages that the data scanner recognizes.

delegate

get delegate(): Promise<(SDKHandle) | null>

@MainActor weak var delegate: (any DataScannerViewControllerDelegate)?

The delegate that handles user interaction with items recognized by the data scanner.

delegate

setDelegate(value?: (SDKHandle) | null): Promise<void>

@MainActor weak var delegate: (any DataScannerViewControllerDelegate)?

The delegate that handles user interaction with items recognized by the data scanner.