MLKitImageLabelingCommon Framework Reference

  • MLKImageLabeler is an object used for processing and labeling images.

  • It can be initialized using imageLabelerWithOptions: with specific configurations.

  • Images can be processed asynchronously using processImage:completion: or synchronously with resultsInImage:error:, although the latter is recommended to be done off the main thread.

  • Results are provided as an array of MLKImageLabel objects, offering information about identified labels in the image.

MLKImageLabeler


@interface MLKImageLabeler : NSObject

An image labeler that processes and labels images.

  • Returns an image labeler with the given options.

    Declaration

    Objective-C

    + (nonnull instancetype)imageLabelerWithOptions:
    (nonnull MLKCommonImageLabelerOptions *)options;

    Parameters

    options

    Options for configuring the image labeler.

    Return Value

    An image labeler configured with the given options.

  • Unavailable. Use the class methods.

    Declaration

    Objective-C

    - (nonnull instancetype)init;

  • Processes the given image for labeling.

    Declaration

    Objective-C

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

    Parameters

    image

    The image to process.
    completion

    Handler to call back on the main queue with labels or error.

  • Returns label results in the given image or nil if there was an error. The image labeling 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 NSArray<MLKImageLabel *> *)
    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

    Array of label results in the given image or nil if there was an error.