MLKitVision Framework Reference
Stay organized with collections
Save and categorize content based on your preferences.
VisionImage
An image or image buffer used for vision detection.
-
The display orientation of the image. The default is .up.
Declaration
Swift
var orientation: Int32 { get set }
-
Initializes a VisionImage object with the given image.
Parameters
image
|
Image to use in vision detection. The given image should be rotated, so its
imageOrientation property is set to .up. The UIImage must have non-NULL CGImage
property.
|
Return Value
A VisionImage instance with the given image.
-
Initializes a VisionImage object with the given image buffer. To improve performance, it is
recommended to minimize the lifespan and number of instances of this class when initializing with
a CMSampleBufferRef.
Declaration
Swift
init(buffer sampleBuffer: CMSampleBuffer)
Parameters
sampleBuffer
|
Image buffer to use in vision detection. The buffer must be based on
a pixel buffer (not compressed data), and the pixel format must be one of:
- kCVPixelFormatType_32BGRA
- kCVPixelFormatType_420YpCbCr8BiPlanarFullRange
- kCVPixelFormatType_420YpCbCr8BiPlanarVideoRange
In practice: this works with the video output of the phone’s camera, but not other
arbitrary sources of CMSampleBufferRefs.
|
Return Value
A VisionImage instance with the given image buffer.
-
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-07-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-07-10 UTC."],[[["\u003cp\u003e\u003ccode\u003eVisionImage\u003c/code\u003e is an object used for vision detection tasks, accepting images or image buffers as input.\u003c/p\u003e\n"],["\u003cp\u003eIt's crucial to set the \u003ccode\u003eimageOrientation\u003c/code\u003e property of input \u003ccode\u003eUIImage\u003c/code\u003e to \u003ccode\u003e.up\u003c/code\u003e before initialization to ensure proper orientation.\u003c/p\u003e\n"],["\u003cp\u003eWhen using \u003ccode\u003eCMSampleBufferRef\u003c/code\u003e for initialization, ensure it's a pixel buffer with a supported pixel format like \u003ccode\u003ekCVPixelFormatType_32BGRA\u003c/code\u003e for optimal performance.\u003c/p\u003e\n"],["\u003cp\u003eFor \u003ccode\u003eCMSampleBufferRef\u003c/code\u003e inputs, compatibility is primarily with phone camera output, not arbitrary buffer sources.\u003c/p\u003e\n"],["\u003cp\u003eDirect initialization using \u003ccode\u003einit()\u003c/code\u003e is unavailable; utilize \u003ccode\u003einit(image:)\u003c/code\u003e or \u003ccode\u003einit(buffer:)\u003c/code\u003e instead.\u003c/p\u003e\n"]]],["`VisionImage` is a class for vision detection using images or image buffers. It has a settable `orientation` property, defaulting to `.up`. It initializes with either an `image`, requiring a rotated image with an `.up` orientation and a non-NULL `CGImage`, or a `CMSampleBuffer` image buffer with specified pixel formats. When using `CMSampleBufferRef`, minimize instance lifespan. Direct initialization using `init()` is unavailable.\n"],null,[]]
