MLKitTextRecognitionCommon Framework Reference

  • TextRecognizer identifies and extracts text within images.

  • It offers both synchronous and asynchronous processing options.

  • Concurrent use with varying language settings may impact performance.

  • Direct use on the main thread is discouraged due to potential UI blocking.

TextRecognizer

class TextRecognizer : NSObject

A text recognizer that recognizes text in an image.

  • Returns a text recognizer with the given options.

    Concurrent usage of multiple TextRecognizer instances with different language options is not recommended, since it may lead to performance degradation.

    Declaration

    Swift

    class func textRecognizer(options: MLKCommonTextRecognizerOptions) -> Self

    Parameters

    options

    Options for configuring the text recognizer.

    Return Value

    An text recognizer configured with the given options.

  • Processes the given image for text recognition.

    Declaration

    Swift

    func process(_ image: MLKitCompatibleImage) async throws -> MLKText

    Parameters

    image

    The image to process.
    completion

    Handler to call back on the main queue when text recognition completes.

  • Returns text recognition result in the given image or nil if there was an error. The text recognition is performed synchronously on the calling thread.

    It is advised to call this method off the main thread to avoid blocking the UI. As a result, an NSException is raised if this method is called on the main thread.

    Declaration

    Swift

    func results(in image: MLKitCompatibleImage) throws -> MLKText

    Parameters

    image

    The image to get results in.
    error

    An optional error parameter populated when there is an error getting results.

    Return Value

    Text recognition result in the given image or nil if there was an error.