MediaPipeTasksVision Framework Reference

MPPImageEmbedderLiveStreamDelegate

@protocol MPPImageEmbedderLiveStreamDelegate <NSObject>

This protocol defines an interface for the delegates of ImageEmbedder object to receive results of asynchronous embedding extraction on images (i.e, when runningMode = .liveStream).

The delegate of ImageEmbedder must adopt ImageEmbedderLiveStreamDelegate protocol. The methods in this protocol are optional.

  • This method notifies a delegate that the results of asynchronous embedding extraction on an image submitted to the ImageEmbedder is available.

    This method is called on a private serial queue created by the ImageEmbedder for performing the asynchronous delegates calls.

    Declaration

    Objective-C

    - (void)imageEmbedder:(nonnull MPPImageEmbedder *)imageEmbedder
    didFinishEmbeddingWithResult:(nullable MPPImageEmbedderResult *)result
         timestampInMilliseconds:(NSInteger)timestampInMilliseconds
                           error:(nullable NSError *)error;

    Parameters

    imageEmbedder

    The image embedder which performed the embedding extraction. This is useful to test equality when there are multiple instances of ImageEmbedder.
    result

    An ImageEmbedderResult object that contains a list of generated image embeddings.
    timestampInMilliseconds

    The timestamp (in milliseconds) which indicates when the input image was sent to the image embedder.
    error

    An optional error parameter populated when there is an error in performing embedding extraction on the input live stream image data.