MLKitTextRecognition Framework Reference

Stay organized with collections Save and categorize content based on your preferences.

MLKTextRecognizer


@interface MLKTextRecognizer : NSObject

A text recognizer that recognizes text in an image.

  • Returns a text recognizer.

    Declaration

    Objective-C

    + (nonnull instancetype)textRecognizer;

    Return Value

    A text recognizer.

  • Unavailable. Use the class method.

    Declaration

    Objective-C

    - (nonnull instancetype)init;
  • 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 results 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 results in the given image or nil if there was an error.