Package apple.vision

Class VNImageRequestHandler

  • All Implemented Interfaces:
    NSObject
    public class VNImageRequestHandler
extends NSObject
    Performs requests on a single image. The VNImageRequestHandler is created with an image that is used to be used for the requests a client might want to schedule. The VNImageRequestHandler retains, but never modifies, the image source for its entire lifetime. The client also must not modify the content of the image source once the VNImageRequestHandler is created otherwise the results are undefined. The VNImageRequestHandler can choose to also cache intermediate representation of the image or other request-specific information for the purposes of runtime performance. API-Since: 11.0

    • Constructor Detail

      • VNImageRequestHandler

        protected VNImageRequestHandler​(org.moe.natj.general.Pointer peer)

    • Method Detail

      • accessInstanceVariablesDirectly

        public static boolean accessInstanceVariablesDirectly()

      • allocWithZone

        public static VNImageRequestHandler allocWithZone​(org.moe.natj.general.ptr.VoidPtr zone)

      • automaticallyNotifiesObserversForKey

        public static boolean automaticallyNotifiesObserversForKey​(@NotNull
                                                           @NotNull java.lang.String key)

      • cancelPreviousPerformRequestsWithTarget

        public static void cancelPreviousPerformRequestsWithTarget​(@NotNull
                                                           @NotNull java.lang.Object aTarget)

      • cancelPreviousPerformRequestsWithTargetSelectorObject

        public static void cancelPreviousPerformRequestsWithTargetSelectorObject​(@NotNull
                                                                         @NotNull java.lang.Object aTarget,
                                                                         @NotNull
                                                                         @NotNull org.moe.natj.objc.SEL aSelector,
                                                                         @Nullable
                                                                         @Nullable java.lang.Object anArgument)

      • classFallbacksForKeyedArchiver

        @NotNull
public static @NotNull NSArray<java.lang.String> classFallbacksForKeyedArchiver()

      • classForKeyedUnarchiver

        @NotNull
public static @NotNull org.moe.natj.objc.Class classForKeyedUnarchiver()

      • debugDescription_static

        public static java.lang.String debugDescription_static()

      • description_static

        public static java.lang.String description_static()

      • hash_static

        public static long hash_static()

      • initWithCGImageOptions

        public VNImageRequestHandler initWithCGImageOptions​(@NotNull
                                                    @NotNull CGImageRef image,
                                                    @NotNull
                                                    @NotNull NSDictionary<java.lang.String,​?> options)
        initWithCGImage:options creates a VNImageRequestHandler to be used for performing requests against the image passed in as a CGImageRef.
        Parameters:
        image - A CGImageRef containing the image to be used for performing the requests. The content of the image cannot be modified.
        options - A dictionary with options specifying auxiliary information for the buffer/image like VNImageOptionCameraIntrinsics

      • initWithCGImageOrientationOptions

        public VNImageRequestHandler initWithCGImageOrientationOptions​(@NotNull
                                                               @NotNull CGImageRef image,
                                                               int orientation,
                                                               @NotNull
                                                               @NotNull NSDictionary<java.lang.String,​?> options)
        initWithCGImage:options creates a VNImageRequestHandler to be used for performing requests against the image passed in as a CGImageRef.
        Parameters:
        image - A CGImageRef containing the image to be used for performing the requests. The content of the image cannot be modified.
        orientation - The orientation of the image/buffer based on the EXIF specification. For details see kCGImagePropertyOrientation. The value has to be an integer from 1 to 8. This supersedes every other orientation information.
        options - A dictionary with options specifying auxiliary information for the buffer/image like VNImageOptionCameraIntrinsics

      • initWithCIImageOptions

        public VNImageRequestHandler initWithCIImageOptions​(@NotNull
                                                    @NotNull CIImage image,
                                                    @NotNull
                                                    @NotNull NSDictionary<java.lang.String,​?> options)
        initWithCIImage:options creates a VNImageRequestHandler to be used for performing requests against the image passed in as a CIImage. [@note] Request results may not be accurate in simulator due to CI's inability to render certain pixel formats in the simulator. The orientation of the original image should be applied for instance by using imageByApplyingOrientation or use the initWithCIImage:options:orientation API.
        Parameters:
        image - A CIImage containing the image to be used for performing the requests. The content of the image cannot be modified.
        options - A dictionary with options specifying auxiliary information for the buffer/image like VNImageOptionCameraIntrinsics

      • initWithCIImageOrientationOptions

        public VNImageRequestHandler initWithCIImageOrientationOptions​(@NotNull
                                                               @NotNull CIImage image,
                                                               int orientation,
                                                               @NotNull
                                                               @NotNull NSDictionary<java.lang.String,​?> options)
        initWithCIImage:options:orientation creates a VNImageRequestHandler to be used for performing requests against the image passed in as a CIImage. [@note] Request results may not be accurate in simulator due to CI's inability to render certain pixel formats in the simulator
        Parameters:
        image - A CIImage containing the image to be used for performing the requests. The content of the image cannot be modified.
        orientation - The orientation of the image/buffer based on the EXIF specification. For details see kCGImagePropertyOrientation. The value has to be an integer from 1 to 8. This supersedes every other orientation information.
        options - A dictionary with options specifying auxiliary information for the buffer/image like VNImageOptionCameraIntrinsics

      • initWithCVPixelBufferOptions

        public VNImageRequestHandler initWithCVPixelBufferOptions​(@NotNull
                                                          @NotNull CVBufferRef pixelBuffer,
                                                          @NotNull
                                                          @NotNull NSDictionary<java.lang.String,​?> options)
        initWithCVPixelBuffer:options creates a VNImageRequestHandler to be used for performing requests against the image passed in as buffer.
        Parameters:
        pixelBuffer - A CVPixelBuffer containing the image to be used for performing the requests. The content of the buffer cannot be modified for the lifetime of the VNImageRequestHandler.
        options - A dictionary with options specifying auxiliary information for the buffer/image like VNImageOptionCameraIntrinsics

      • initWithCVPixelBufferOrientationOptions

        public VNImageRequestHandler initWithCVPixelBufferOrientationOptions​(@NotNull
                                                                     @NotNull CVBufferRef pixelBuffer,
                                                                     int orientation,
                                                                     @NotNull
                                                                     @NotNull NSDictionary<java.lang.String,​?> options)
        initWithCVPixelBuffer:options creates a VNImageRequestHandler to be used for performing requests against the image passed in as buffer.
        Parameters:
        pixelBuffer - A CVPixelBuffer containing the image to be used for performing the requests. The content of the buffer cannot be modified for the lifetime of the VNImageRequestHandler.
        orientation - The orientation of the image/buffer based on the EXIF specification. For details see kCGImagePropertyOrientation. The value has to be an integer from 1 to 8. This supersedes every other orientation information.
        options - A dictionary with options specifying auxiliary information for the buffer/image like VNImageOptionCameraIntrinsics

      • initWithDataOptions

        public VNImageRequestHandler initWithDataOptions​(@NotNull
                                                 @NotNull NSData imageData,
                                                 @NotNull
                                                 @NotNull NSDictionary<java.lang.String,​?> options)
        initWithData:options creates a VNImageRequestHandler to be used for performing requests against an image contained in an NSData object. [@note] Request results may not be accurate in simulator due to CI's inability to render certain pixel formats in the simulator
        Parameters:
        imageData - An NSData object containing the content of the image to be used for performing the requests. See CIImage imageWithData for supported format. The content of the image cannot be modified.
        options - A dictionary with options specifying auxiliary information for the buffer/image like VNImageOptionCameraIntrinsics

      • initWithDataOrientationOptions

        public VNImageRequestHandler initWithDataOrientationOptions​(@NotNull
                                                            @NotNull NSData imageData,
                                                            int orientation,
                                                            @NotNull
                                                            @NotNull NSDictionary<java.lang.String,​?> options)
        initWithData:options creates a VNImageRequestHandler to be used for performing requests against an image contained in an NSData object. [@note] Request results may not be accurate in simulator due to CI's inability to render certain pixel formats in the simulator
        Parameters:
        imageData - An NSData object containing the content of the image to be used for performing the requests. See CIImage imageWithData for supported format. The content of the image cannot be modified.
        orientation - The orientation of the image/buffer based on the EXIF specification. For details see kCGImagePropertyOrientation. The value has to be an integer from 1 to 8. This supersedes every other orientation information.
        options - A dictionary with options specifying auxiliary information for the buffer/image like VNImageOptionCameraIntrinsics

      • initWithURLOptions

        public VNImageRequestHandler initWithURLOptions​(@NotNull
                                                @NotNull NSURL imageURL,
                                                @NotNull
                                                @NotNull NSDictionary<java.lang.String,​?> options)
        initWithURL:options creates a VNImageRequestHandler to be used for performing requests against an image specified by it's URL [@note] Request results may not be accurate in simulator due to CI's inability to render certain pixel formats in the simulator
        Parameters:
        imageURL - A URL pointing at an image to be used for performing the requests. The image has to be in a format that is supported by ImageIO. The content of the image cannot be modified.
        options - A dictionary with options specifying auxiliary information for the buffer/image like VNImageOptionCameraIntrinsics

      • initWithURLOrientationOptions

        public VNImageRequestHandler initWithURLOrientationOptions​(@NotNull
                                                           @NotNull NSURL imageURL,
                                                           int orientation,
                                                           @NotNull
                                                           @NotNull NSDictionary<java.lang.String,​?> options)
        initWithURL:options creates a VNImageRequestHandler to be used for performing requests against an image specified by it's URL [@note] Request results may not be accurate in simulator due to CI's inability to render certain pixel formats in the simulator
        Parameters:
        imageURL - A URL pointing at an image to be used for performing the requests. The image has to be in a format that is supported by ImageIO. The content of the image cannot be modified.
        orientation - The orientation of the image/buffer based on the EXIF specification. For details see kCGImagePropertyOrientation. The value has to be an integer from 1 to 8. This supersedes every other orientation information.
        options - A dictionary with options specifying auxiliary information for the buffer/image like VNImageOptionCameraIntrinsics

      • instanceMethodSignatureForSelector

        public static NSMethodSignature instanceMethodSignatureForSelector​(org.moe.natj.objc.SEL aSelector)

      • instancesRespondToSelector

        public static boolean instancesRespondToSelector​(org.moe.natj.objc.SEL aSelector)

      • isSubclassOfClass

        public static boolean isSubclassOfClass​(org.moe.natj.objc.Class aClass)

      • keyPathsForValuesAffectingValueForKey

        @NotNull
public static @NotNull NSSet<java.lang.String> keyPathsForValuesAffectingValueForKey​(@NotNull
                                                                                     @NotNull java.lang.String key)

      • performRequestsError

        public boolean performRequestsError​(@NotNull
                                    @NotNull NSArray<? extends VNRequest> requests,
                                    @Nullable
                                    @Nullable org.moe.natj.general.ptr.Ptr<NSError> error)
        performRequests schedules one or more VNRequests to be performed. The function returns once all requests have been finished. The results of the VNRequests as well any possible errors of the individual requests are reported in the VNRequests results and error properties.
        Parameters:
        requests - An NSArray of VNRequests that are to be performed.
        error - Returns an error that happened during scheduling of the requests. Check individual requests results and errors for their respective success and failures. This parameter is optional.
        Returns:
        Returns true if all requests were scheduled and performed. Check individual requests results and errors for their respective success and failures.

      • resolveClassMethod

        public static boolean resolveClassMethod​(org.moe.natj.objc.SEL sel)

      • resolveInstanceMethod

        public static boolean resolveInstanceMethod​(org.moe.natj.objc.SEL sel)

      • setVersion_static

        public static void setVersion_static​(long aVersion)

      • superclass_static

        public static org.moe.natj.objc.Class superclass_static()

      • version_static

        public static long version_static()

      • initWithCMSampleBufferOptions

        public VNImageRequestHandler initWithCMSampleBufferOptions​(@NotNull
                                                           @NotNull CMSampleBufferRef sampleBuffer,
                                                           @NotNull
                                                           @NotNull NSDictionary<java.lang.String,​?> options)
        Creates a VNImageRequestHandler to be used for performing requests against the image buffer contained in the CMSampleBufferRef [@note] CMSampleBuffers can contain metadata like camera intrinsics that will be used by algorithms supporting it unless overwritten by the options. API-Since: 14.0
        Parameters:
        sampleBuffer - A CMSampleBuffer containing the imageBuffer that will be used for performing the requests. Not all types of sample buffers are supported. They need to contain a CVImageBuffer, be valid and ready.
        options - A dictionary with options specifying auxiliary information for the buffer/image like VNImageOptionCameraIntrinsics

      • initWithCMSampleBufferOrientationOptions

        public VNImageRequestHandler initWithCMSampleBufferOrientationOptions​(@NotNull
                                                                      @NotNull CMSampleBufferRef sampleBuffer,
                                                                      int orientation,
                                                                      @NotNull
                                                                      @NotNull NSDictionary<java.lang.String,​?> options)
        Creates a VNImageRequestHandler to be used for performing requests against the image buffer contained in the CMSampleBufferRef [@note] CMSampleBuffers can contain metadata like camera intrinsics that will be used by algorithms supporting it unless overwritten by the options. [@note] Because CoreImage is unable to render certain pixel formats in the iOS simulator, request results may not be accurate in those cases. API-Since: 14.0
        Parameters:
        sampleBuffer - A CMSampleBuffer containing the imageBuffer that will be used for performing the requests. Not all types of sample buffers are supported. They need to contain a CVImageBuffer, be valid and ready.
        orientation - The orientation of the image/buffer based on the EXIF specification. For details see kCGImagePropertyOrientation. The value has to be an integer from 1 to 8. This supersedes every other orientation information.
        options - A dictionary with options specifying auxiliary information for the buffer/image like VNImageOptionCameraIntrinsics

      • initWithCMSampleBufferDepthDataOrientationOptions

        public VNImageRequestHandler initWithCMSampleBufferDepthDataOrientationOptions​(@NotNull
                                                                               @NotNull CMSampleBufferRef sampleBuffer,
                                                                               @NotNull
                                                                               @NotNull AVDepthData depthData,
                                                                               int orientation,
                                                                               @NotNull
                                                                               @NotNull NSDictionary<java.lang.String,​?> options)
        Creates a VNImageRequestHandler to be used for performing requests against the image buffer contained in the CMSampleBufferRef [@note] CMSampleBuffers can contain metadata like camera intrinsics that will be used by algorithms supporting it unless overwritten by the options. [@note] Because CoreImage is unable to render certain pixel formats in the iOS simulator, request results may not be accurate in those cases. API-Since: 17.0
        Parameters:
        sampleBuffer - A CMSampleBuffer containing the imageBuffer that will be used for performing the requests. Not all types of sample buffers are supported. They need to contain a CVImageBuffer, be valid and ready.
        depthData - An AVDepthData instance associated with the pixelBuffer
        orientation - The orientation of the image and depth buffers based on the EXIF specification. For details see kCGImagePropertyOrientation. The value has to be an integer from 1 to 8. This supersedes every other orientation information and should match for both buffers.
        options - A dictionary with options specifying auxiliary information for the buffer/image

      • initWithCVPixelBufferDepthDataOrientationOptions

        public VNImageRequestHandler initWithCVPixelBufferDepthDataOrientationOptions​(@NotNull
                                                                              @NotNull CVBufferRef pixelBuffer,
                                                                              @NotNull
                                                                              @NotNull AVDepthData depthData,
                                                                              int orientation,
                                                                              @NotNull
                                                                              @NotNull NSDictionary<java.lang.String,​?> options)
        initWithCVPixelBuffer:depthData:orientation:options creates a VNImageRequestHandler to be used for performing requests against the image passed in as buffer with depth information.
        Parameters:
        pixelBuffer - A CVPixelBuffer containing the image to be used for performing the requests. The content of the buffer cannot be modified for the lifetime of the VNImageRequestHandler.
        depthData - An AVDepthData instance associated with the pixelBuffer
        orientation - The orientation of the image and depth buffers based on the EXIF specification. For details see kCGImagePropertyOrientation. The value has to be an integer from 1 to 8. This supersedes every other orientation information and should match for both buffers.
        options - A dictionary with options specifying auxiliary information for the buffer/image API-Since: 17.0

      • useStoredAccessor

        @Deprecated
public static boolean useStoredAccessor()
        Deprecated.