MLKitImageLabelingCommon Framework Reference

  • ImageLabeler is a class used for processing and labeling images within the ML Kit.

  • It offers both synchronous and asynchronous processing methods: results(in:) and process(_:completion:) respectively.

  • Initialization is done through the imageLabeler(options:) class method, using MLKCommonImageLabelerOptions for configuration.

  • Results are provided as an array of MLKImageLabel objects, representing identified labels within the image.

  • Direct instantiation using init is unavailable; factory methods are preferred.

ImageLabeler

class ImageLabeler : NSObject

An image labeler that processes and labels images.

  • Returns an image labeler with the given options.

    Declaration

    Swift

    class func imageLabeler(options: MLKCommonImageLabelerOptions) -> Self

    Parameters

    options

    Options for configuring the image labeler.

    Return Value

    An image labeler configured with the given options.

  • Unavailable. Use the class methods.

  • Processes the given image for labeling.

    Declaration

    Swift

    func process(_ image: MLKitCompatibleImage, completion: @escaping ImageLabelingCallback)

    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

    Swift

    func results(in image: MLKitCompatibleImage) throws -> [MLKImageLabel]

    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.