MLKitTextRecognitionCommon Framework Reference

  • MLKTextRecognizer is an object used for recognizing text within images.

  • It provides methods for both synchronous and asynchronous text recognition.

  • Developers can configure the recognizer with custom options, such as language preferences.

  • Results are returned as MLKText objects, containing identified text and its location in the image.

  • Using multiple MLKTextRecognizer instances with varying language options concurrently might impact performance.

MLKTextRecognizer


@interface MLKTextRecognizer : 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

    Objective-C

    + (nonnull instancetype)textRecognizerWithOptions:
    (nonnull MLKCommonTextRecognizerOptions *)options;

    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

    Objective-C

    - (void)processImage:(nonnull id<MLKCompatibleImage>)image
          completion:(nonnull MLKTextRecognitionCallback)completion;

    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

    Objective-C

    - (nullable MLKText *)resultsInImage:(nonnull id<MLKCompatibleImage>)image
                               error:(NSError *_Nullable *_Nullable)error;

    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.