Package-level declarations
Types
Represents the auto-focus algorithm used by the CameraDevice, either while continuously keeping a scene in focus (via auto-3A / AE/AF/AWB), or for a metering action.
A constraint to prefer a binned format, or prefer a non-binned format.
The bounding box around a ScannedObject, in camera-space coordinates (0.0 to 1.0). Convert it to view-space with the preview view's convertCameraPointToViewPoint.
Per-frame calibration data, to counter-apply the transformations of the Camera/ISP: undo distortion correction, or compute the scene in 3D space. iOS only.
A CameraController controls a CameraDevice connected to a CameraSession: zoom, torch, exposure, focus…
Configuration options of a CameraController.
The CameraDepthFrameOutput streams Depth frames from the Camera, on devices supporting depth (whose CameraDevice.mediaTypes contain MediaType.DEPTH).
The CameraDevice represents a physical or virtual Camera Device.
The CameraDeviceFactory allows getting CameraDevices, listening to device changes, and querying extensions or preferred Cameras.
Either a concrete CameraDevice, or a TargetCameraPosition to automatically select the default CameraDevice at the given position.
A vendor-specific Camera extension, such as Night mode or Bokeh.
The type of a vendor-specific CameraExtension.
The CameraFactory allows creating various other Camera related objects.
The CameraFrameOutput streams Frames from the Camera synchronously, aka "Frame Processing".
The CameraObjectOutput scans objects (codes, faces, bodies…) with the platform's built-in detectors. iOS only: on Android, use the barcode module (ML Kit) on a CameraFrameOutput instead.
Represents the orientation, relative to a base anchor.
Represents an output of a CameraSession, for example a preview, a photo or a video output.
Specifies options for an output in a CameraSessionConnection.
Synchronizes 2 or more CameraOutputs to align their timestamps, most commonly a CameraFrameOutput and a CameraDepthFrameOutput so their Frames and Depth frames match. iOS only.
A CameraOutput capturing Photos, in memory (capturePhoto) or directly to a file (capturePhotoToFile).
Represents the physical position of a CameraDevice on the device.
An output that streams the Camera feed to a preview view.
Represents a Camera Session.
A resolved session-level configuration for a CameraSession, the result of negotiating Constraints.
Session-wide configuration for a CameraSession.
Specifies a single Camera input stream connection streaming into zero or more outputs.
A CameraOutput recording videos (possibly with audio) to files, through Recorders.
Callbacks of a CameraPhotoOutput.capturePhoto call.
Settings of a single CameraPhotoOutput.capturePhoto call.
Represents the range of YUV color components.
Represents the color space of a DynamicRange.
Commonly used TargetDynamicRanges.
Commonly used resolutions, in portrait orientation, to be used as target resolutions for outputs.
Constraints are session configuration options that are negotiated by the CameraSession to find a closest-matching working Camera configuration.
A Depth frame, captured by a CameraDepthFrameOutput or embedded in a Photo (Photo.depth).
The measurement accuracy of a Depth frame.
The quality classification of a Depth frame.
Configuration options for a CameraDepthFrameOutput.
Represents the pixel format of a depth image buffer.
A filter to find the best matching CameraDevice with getCameraDevice.
Represents the type of a physical or logical Camera lens on the CameraDevice.
Represents a Dynamic Range, often used for recording HDR videos.
Represents the bit-depth of a DynamicRange.
Represents the exposure mode of a CameraDevice.
The flash mode of a photo capture, see CapturePhotoSettings.flashMode.
Represents the focus mode of a CameraDevice.
Options for a focus metering operation.
Configures the responsiveness of a AE/AF/AWB focus operation.
A constraint to set a given fps for any Video, Frame or Preview Streams.
A single Camera Frame, backed by a native buffer (an ImageProxy on Android, a CMSampleBuffer on iOS).
Converts Frames and Depth frames to Images (port of V5's FrameConverter). Use the HybridFrameConverter instance:
Represents the reason why a Frame was dropped by the Camera pipeline.
Either a Frame or a Depth frame, as delivered together by a CameraOutputSynchronizer. This is VisionCamera's Frame | Depth union.
Configuration options for a CameraFrameOutput.
A single plane of a planar Frame, e.g. the Y or the UV plane of a YUV Frame.
Renders Frames into a target. For example, a FrameRendererView connected to a FrameRenderer renders its Frames on screen. It could also feed a custom video recorder.
An Android android.view.View rendering the Frames of a FrameRenderer on screen.
A UIKit view displaying the Frames rendered by a FrameRenderer (port of V5's HybridFrameRendererView.swift).
A GestureController controls a property of a CameraController with a user gesture, e.g. the zoom with a pinch (ZoomGestureController).
The platform's FrameConverter (V5's HybridFrameConverter).
A decoded, ready to display image, the equivalent of the Image of react-native-nitro-image that VisionCamera returns from Photo.toImage, CapturePhotoCallbacks.onPreviewImageAvailable, the preview view's takeSnapshot() and the FrameConverter.
The reason a CameraSession was interrupted.
Represents a subscription to any kind of listener.
A geographic location, embedded in the metadata of a Photo (CapturePhotoSettings.location) or a video (RecorderSettings.location).
The timestamp, orientation and mirroring of a captured media sample.
Specifies the metering mode, also known as the 3A operation.
A point used to focus AE/AF/AWB on the Camera via CameraController.focusTo.
Represents the target mirroring setting for a Camera Output.
An unmanaged memory pointer to a native platform buffer.
A CameraDevice backed by a CameraX CameraInfo.
A CameraOutput backed by a CameraX UseCase (port of V5's public/NativeCameraOutput.kt).
A CameraOutput backed by an AVCaptureOutput (photo, video, frames...), that is added to the AVCaptureSession and manually connected to its input in CameraSession.configure.
Gives access to the native AVDepthData of a Depth (port of V5's Public/NativeDepth.swift).
A Frame or Depth created by VisionCamera on Android, backed by a CameraX ImageProxy (port of V5's public/NativeFrame.kt).
Gives access to the native CMSampleBuffer of a Frame (port of V5's Public/NativeFrame.swift).
A FrameRenderer created by VisionCamera on Android, rendering into a Surface.
A native thread: an Executor on Android, a DispatchQueue on iOS.
Creates NativeThreads, for advanced asynchronous processing. Camera outputs already create their own threads, so this is rarely needed.
Configuration options for a CameraObjectOutput.
Listens to CameraOrientation changes of the device or the interface.
Represents the source of a CameraOrientation.
The configuration applied to an output when the CameraSession is configured.
Represents the type of an output stream, used to query available resolutions via CameraDevice.getSupportedResolutions.
Represents the status of a Permission - e.g. Camera or Microphone.
A photo captured in memory by CameraPhotoOutput.capturePhoto.
Represents the container format of a captured Photo.
A photo captured by CameraPhotoOutput.capturePhotoToFile and written to a file.
A constraint to set Photo HDR for Photo Outputs.
Configuration options of a CameraPhotoOutput, see CameraFactory.createPhotoOutput.
Represents any kind of pixel format for a media sample:
A constraint to prefer a streaming Format with the given target PixelFormat.
The implementation used by the preview view on Android. Ignored on iOS.
How the preview view scales the Camera feed into its bounds.
A constraint to set a TargetStabilizationMode for Preview Streams.
An Android android.view.View displaying the Camera feed of a CameraPreviewOutput.
A UIKit view displaying the Camera feed of a CameraPreviewOutput (port of V5's HybridPreviewView.swift).
Specifies the prioritization between speed and quality for photo capture.
Records a single video to a file, see CameraVideoOutput.createRecorder. To record several videos, create several Recorders.
The container file type of a CameraVideoOutput's recordings.
Settings of a Recorder, see CameraVideoOutput.createRecorder.
Why a Recorder's recording finished. In every case, the video file is fully written and usable.
A constraint to bias the resolution of the given CameraOutput over other constraints.
Represents a Camera Output that participates in resolution negotiations.
The resolution an output would like to stream at.
A machine-readable code, such as a QR code. iOS only.
A face. iOS only.
Any kind of object scanned by a CameraObjectOutput: a ScannedCode, a ScannedFace, or another object like a body. iOS only.
The type of a ScannedObject.
Configures the adaptiveness of the AE/AF/AWB pipeline after a metering operation has settled.
Specifies the stabilization algorithm/mode to use.
The kind of stream a ResolutionNegotiationParticipant negotiates a resolution for.
A GestureController that calls CameraController.focusTo when the user taps the view.
Represents the target physical position of a CameraDevice on the device.
Represents a target DynamicRange, for example to be used with the Constraints API. None of its components can be UNKNOWN.
Represents a PhotoContainerFormat that can be used to capture Photos in.
Specifies a target stabilization mode: either a specific StabilizationMode (which has to be supported by the CameraDevice), TargetStabilizationMode.Auto or TargetStabilizationMode.Off.
Represents a desired pixel format for a video pipeline, e.g. the format a frame output streams frames in.
Represents a video codec for encoded video data.
A constraint to set a TargetDynamicRange for Video Streams.
Configuration options of a CameraVideoOutput, see CameraFactory.createVideoOutput.
Output settings of a CameraVideoOutput, see CameraVideoOutput.setOutputSettings.
Represents the pixel format of a video image buffer. Video formats are either YUV or RGB. The most commonly used format is YUV_420_8_BIT_VIDEO.
A constraint to set a TargetStabilizationMode for Video Streams.
The entry point of KMP Vision Camera: the platform's CameraFactory.
An error thrown by KMP Vision Camera, for example when a CameraSession fails to configure.
Represents the per-channel gains applied for white balance correction.
Represents the white balance mode of a CameraDevice.
Represents a white balance setting expressed as a color temperature and tint offset.
A GestureController that changes CameraController.zoom with a pinch gesture.
Properties
The resolution of the stream currently flowing through this connection's first input port, in sensor-native (un-rotated) pixels, or null until the session is configured.
The Surface.ROTATION_* value of this CameraOrientation, used as a CameraX target rotation.
Functions
A CoroutineDispatcher running coroutines on this NativeThread, e.g. to process frames asynchronously on the output's thread with withContext(frameOutput.thread.asCoroutineDispatcher()).
Get the CameraDevice that best satisfies the given filter at the given position, or the platform's default CameraDevice at that position if no filter is given.
Converts this TargetCameraPosition to the matching CameraPosition.
Gets the UIImage of this Image. Its orientation and mirroring are applied through UIImage.imageOrientation.
Converts this Photo to a UIImage, applying its Photo.orientation and Photo.isMirrored through the image's imageOrientation. Same as Photo.toImage followed by Image.toUIImage().
Converts this CameraOrientation to a UIImageOrientation, mirrored if isMirrored.