VisionKit · IOS API REFERENCE

ImageAnalysis

class · iOS 16.0+ · SDK 27.1

final class ImageAnalysis

An object that represents the results of analyzing an image, and provides the input for the Live Text interface object. An `ImageAnalysis` object represents the results of an ``ImageAnalyzer`` object finding items in an image that people can interact with. To create an `ImageAnalysis` object, use the `ImageAnalyzer` class's ``ImageAnalyzer/analyze(_:configuration:)`` method variety, passing the image and an ``ImageAnalyzer/Configuration`` object that specifies the items you want to find. Then pass the image analysis to either an ``ImageAnalysisInteraction`` object for iOS or an ``ImageAnalysisOverlayView`` object for macOS to provide the Live Text interface.

Members (2)

method · iOS 16.0+

hasResults

TypeScript

hasResults(analysisTypes: ImageAnalyzer_AnalysisTypes): boolean

Swift declaration

final func hasResults(for analysisTypes: ImageAnalyzer.AnalysisTypes) -> Bool

Returns a Boolean value that indicates whether the analysis finds the specified types in the image. - Parameter analysisTypes: The data types you want to find in the image. - Returns: `true` if the image analysis has results for the specified types; otherwise, `false`.

get · iOS 16.0+

transcript

TypeScript

get transcript(): string

Swift declaration

final var transcript: String { get }

The string that the text items in the image represent. The text appears in the reading order of the language and region.

Skipped declarations

No declarations were skipped in this snapshot.

All VisionKit types →