CaptureResult Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
The subset of the results of a single image capture from the image sensor.
[Android.Runtime.Register("android/hardware/camera2/CaptureResult", DoNotGenerateAcw=true)]
public class CaptureResult : Android.Hardware.Camera2.CameraMetadata[<Android.Runtime.Register("android/hardware/camera2/CaptureResult", DoNotGenerateAcw=true)>]
type CaptureResult = class
inherit CameraMetadata- Inheritance
- Derived
- Attributes
Remarks
The subset of the results of a single image capture from the image sensor.
Contains a subset of the final configuration for the capture hardware (sensor, lens, flash), the processing pipeline, the control algorithms, and the output buffers.
CaptureResults are produced by a CameraDevice after processing a CaptureRequest. All properties listed for capture requests can also be queried on the capture result, to determine the final values used for capture. The result also includes additional metadata about the state of the camera device during the capture.
Not all properties returned by CameraCharacteristics#getAvailableCaptureResultKeys() are necessarily available. Some results are CaptureResult partial and will not have every key set. Only TotalCaptureResult total results are guaranteed to have every key available that was enabled by the request.
CaptureResult objects are immutable.
Java documentation for android.hardware.camera2.CaptureResult.
Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.
Constructors
| CaptureResult(IntPtr, JniHandleOwnership) |
A constructor used when creating managed representations of JNI objects; called by the runtime. |
Fields
| AutomotiveLensFacingExteriorFront |
Obsolete.
The camera device faces the front of the vehicle body frame. (Inherited from CameraMetadata) |
| AutomotiveLensFacingExteriorLeft |
Obsolete.
The camera device faces the left side of the vehicle body frame. (Inherited from CameraMetadata) |
| AutomotiveLensFacingExteriorOther |
Obsolete.
The camera device faces the outside of the vehicle body frame but not exactly one of the exterior sides defined by this enum. (Inherited from CameraMetadata) |
| AutomotiveLensFacingExteriorRear |
Obsolete.
The camera device faces the rear of the vehicle body frame. (Inherited from CameraMetadata) |
| AutomotiveLensFacingExteriorRight |
Obsolete.
The camera device faces the right side of the vehicle body frame. (Inherited from CameraMetadata) |
| AutomotiveLensFacingInteriorOther |
Obsolete.
The camera device faces the inside of the vehicle body frame but not exactly one of seats described by this enum. (Inherited from CameraMetadata) |
| AutomotiveLensFacingInteriorSeatRow1Center |
Obsolete.
The camera device faces the center seat of the first row. (Inherited from CameraMetadata) |
| AutomotiveLensFacingInteriorSeatRow1Left |
Obsolete.
The camera device faces the left side seat of the first row. (Inherited from CameraMetadata) |
| AutomotiveLensFacingInteriorSeatRow1Right |
Obsolete.
The camera device faces the right seat of the first row. (Inherited from CameraMetadata) |
| AutomotiveLensFacingInteriorSeatRow2Center |
Obsolete.
The camera device faces the center seat of the second row. (Inherited from CameraMetadata) |
| AutomotiveLensFacingInteriorSeatRow2Left |
Obsolete.
The camera device faces the left side seat of the second row. (Inherited from CameraMetadata) |
| AutomotiveLensFacingInteriorSeatRow2Right |
Obsolete.
The camera device faces the right side seat of the second row. (Inherited from CameraMetadata) |
| AutomotiveLensFacingInteriorSeatRow3Center |
Obsolete.
The camera device faces the center seat of the third row. (Inherited from CameraMetadata) |
| AutomotiveLensFacingInteriorSeatRow3Left |
Obsolete.
The camera device faces the left side seat of the third row. (Inherited from CameraMetadata) |
| AutomotiveLensFacingInteriorSeatRow3Right |
Obsolete.
The camera device faces the right seat of the third row. (Inherited from CameraMetadata) |
| AutomotiveLocationExteriorFront |
Obsolete.
The camera device exists outside of the vehicle body frame and on its front side. (Inherited from CameraMetadata) |
| AutomotiveLocationExteriorLeft |
Obsolete.
The camera device exists outside and on left side of the vehicle body frame. (Inherited from CameraMetadata) |
| AutomotiveLocationExteriorOther |
Obsolete.
The camera exists outside of the vehicle body frame but not exactly on one of the exterior locations this enum defines. (Inherited from CameraMetadata) |
| AutomotiveLocationExteriorRear |
Obsolete.
The camera device exists outside of the vehicle body frame and on its rear side. (Inherited from CameraMetadata) |
| AutomotiveLocationExteriorRight |
Obsolete.
The camera device exists outside and on right side of the vehicle body frame. (Inherited from CameraMetadata) |
| AutomotiveLocationExtraFront |
Obsolete.
The camera device exists outside of the extra vehicle's body frame and on its front side. (Inherited from CameraMetadata) |
| AutomotiveLocationExtraLeft |
Obsolete.
The camera device exists outside and on left side of the extra vehicle body. (Inherited from CameraMetadata) |
| AutomotiveLocationExtraOther |
Obsolete.
The camera device exists on an extra vehicle, such as the trailer, but not exactly on one of front, rear, left, or right side. (Inherited from CameraMetadata) |
| AutomotiveLocationExtraRear |
Obsolete.
The camera device exists outside of the extra vehicle's body frame and on its rear side. (Inherited from CameraMetadata) |
| AutomotiveLocationExtraRight |
Obsolete.
The camera device exists outside and on right side of the extra vehicle body. (Inherited from CameraMetadata) |
| AutomotiveLocationInterior |
Obsolete.
The camera device exists inside of the vehicle cabin. (Inherited from CameraMetadata) |
| ControlAfSceneChangeDetected |
Scene change is detected within the AF region(s). (Inherited from CameraMetadata) |
| ControlAfSceneChangeNotDetected |
Scene change is not detected within the AF region(s). (Inherited from CameraMetadata) |
| ControlAutoframingOff |
Obsolete.
Disable autoframing. (Inherited from CameraMetadata) |
| ControlAutoframingOn |
Obsolete.
Enable autoframing to keep people in the frame's field of view. (Inherited from CameraMetadata) |
| ControlAutoframingStateConverged |
Obsolete.
Auto-framing has reached a stable state (frame/fov is not being adjusted). (Inherited from CameraMetadata) |
| ControlAutoframingStateFraming |
Obsolete.
Auto-framing is in process - either zooming in, zooming out or pan is taking place. (Inherited from CameraMetadata) |
| ControlAutoframingStateInactive |
Obsolete.
Auto-framing is inactive. (Inherited from CameraMetadata) |
| ControlExtendedSceneModeBokehContinuous |
Obsolete.
Bokeh effect must not slow down capture rate relative to sensor raw output, and the effect is applied to all processed streams no larger than the maximum streaming dimension. (Inherited from CameraMetadata) |
| ControlExtendedSceneModeBokehStillCapture |
Obsolete.
High quality bokeh mode is enabled for all non-raw streams (including YUV, JPEG, and IMPLEMENTATION_DEFINED) when capture intent is STILL_CAPTURE. (Inherited from CameraMetadata) |
| ControlExtendedSceneModeDisabled |
Obsolete.
Extended scene mode is disabled. (Inherited from CameraMetadata) |
| ControlModeUseExtendedSceneMode |
Obsolete.
Use a specific extended scene mode. (Inherited from CameraMetadata) |
| ControlSettingsOverrideOff |
Obsolete.
No keys are applied sooner than the other keys when applying CaptureRequest settings to the camera device. (Inherited from CameraMetadata) |
| ControlSettingsOverrideZoom |
Obsolete.
Zoom related keys are applied sooner than the other keys in the CaptureRequest. (Inherited from CameraMetadata) |
| ControlVideoStabilizationModePreviewStabilization |
Obsolete.
Preview stabilization, where the preview in addition to all other non-RAW streams are stabilized with the same quality of stabilization, is enabled. (Inherited from CameraMetadata) |
| DistortionCorrectionModeFast |
Lens distortion correction is applied without reducing frame rate relative to sensor output. (Inherited from CameraMetadata) |
| DistortionCorrectionModeHighQuality |
High-quality distortion correction is applied, at the cost of possibly reduced frame rate relative to sensor output. (Inherited from CameraMetadata) |
| DistortionCorrectionModeOff |
No distortion correction is applied. (Inherited from CameraMetadata) |
| LensPoseReferenceAutomotive |
The value of |
| LensPoseReferenceGyroscope |
The value of |
| LensPoseReferencePrimaryCamera |
The value of |
| LensPoseReferenceUndefined |
The camera device cannot represent the values of |
| LogicalMultiCameraSensorSyncTypeApproximate |
A software mechanism is used to synchronize between the physical cameras. (Inherited from CameraMetadata) |
| LogicalMultiCameraSensorSyncTypeCalibrated |
The camera device supports frame timestamp synchronization at the hardware level, and the timestamp of a physical stream image accurately reflects its start-of-exposure time. (Inherited from CameraMetadata) |
| RequestAvailableCapabilitiesColorSpaceProfiles |
Obsolete.
The device supports querying the possible combinations of color spaces, image
formats, and dynamic range profiles supported by the camera and requesting a
particular color space for a session via
|
| RequestAvailableCapabilitiesDynamicRangeTenBit |
Obsolete.
The device supports one or more 10-bit camera outputs according to the dynamic range
profiles specified in
|
| RequestAvailableCapabilitiesOfflineProcessing |
Obsolete.
The camera device supports the OFFLINE_PROCESSING use case. (Inherited from CameraMetadata) |
| RequestAvailableCapabilitiesRemosaicReprocessing |
Obsolete.
The device supports reprocessing from the |
| RequestAvailableCapabilitiesStreamUseCase |
Obsolete.
The camera device supports selecting a per-stream use case via
|
| RequestAvailableCapabilitiesSystemCamera |
Obsolete.
The camera device is only accessible by Android's system components and privileged applications. (Inherited from CameraMetadata) |
| RequestAvailableCapabilitiesUltraHighResolutionSensor |
Obsolete.
This camera device is capable of producing ultra high resolution images in
addition to the image sizes described in the
|
| ScalerAvailableStreamUseCasesCroppedRaw |
Obsolete.
Cropped RAW stream when the client chooses to crop the field of view. (Inherited from CameraMetadata) |
| ScalerAvailableStreamUseCasesDefault |
Obsolete.
Default stream use case. (Inherited from CameraMetadata) |
| ScalerAvailableStreamUseCasesPreview |
Obsolete.
Live stream shown to the user. (Inherited from CameraMetadata) |
| ScalerAvailableStreamUseCasesPreviewVideoStill |
Obsolete.
One single stream used for combined purposes of preview, video, and still capture. (Inherited from CameraMetadata) |
| ScalerAvailableStreamUseCasesStillCapture |
Obsolete.
Still photo capture. (Inherited from CameraMetadata) |
| ScalerAvailableStreamUseCasesVideoCall |
Obsolete.
Long-running video call optimized for both power efficiency and video quality. (Inherited from CameraMetadata) |
| ScalerAvailableStreamUseCasesVideoRecord |
Obsolete.
Recording video clips. (Inherited from CameraMetadata) |
| ScalerRotateAndCrop180 |
Obsolete.
Processed images are rotated by 180 degrees. (Inherited from CameraMetadata) |
| ScalerRotateAndCrop270 |
Obsolete.
Processed images are rotated by 270 degrees clockwise, and then cropped to the original aspect ratio. (Inherited from CameraMetadata) |
| ScalerRotateAndCrop90 |
Obsolete.
Processed images are rotated by 90 degrees clockwise, and then cropped to the original aspect ratio. (Inherited from CameraMetadata) |
| ScalerRotateAndCropAuto |
Obsolete.
The camera API automatically selects the best concrete value for rotate-and-crop based on the application's support for resizability and the current multi-window mode. (Inherited from CameraMetadata) |
| ScalerRotateAndCropNone |
Obsolete.
No rotate and crop is applied. (Inherited from CameraMetadata) |
| SensorPixelModeDefault |
Obsolete.
This is the default sensor pixel mode. (Inherited from CameraMetadata) |
| SensorPixelModeMaximumResolution |
Obsolete.
In this mode, sensors typically do not bin pixels, as a result can offer larger image sizes. (Inherited from CameraMetadata) |
| SensorReadoutTimestampHardware |
Obsolete.
This camera device supports the onReadoutStarted callback as well as outputting readout timestamps. (Inherited from CameraMetadata) |
| SensorReadoutTimestampNotSupported |
Obsolete.
This camera device doesn't support readout timestamp and onReadoutStarted callback. (Inherited from CameraMetadata) |
| StatisticsOisDataModeOff |
Do not include OIS data in the capture result. (Inherited from CameraMetadata) |
| StatisticsOisDataModeOn |
Include OIS data in the capture result. (Inherited from CameraMetadata) |
Properties
| BlackLevelLock |
Whether black-level compensation is locked to its current values, or is free to vary. |
| CameraId |
Get the camera ID of the camera that produced this capture result. |
| Class |
Returns the runtime class of this |
| ColorCorrectionAberrationMode |
Mode of operation for the chromatic aberration correction algorithm. |
| ColorCorrectionGains |
Gains applying to Bayer raw color channels for white-balance. |
| ColorCorrectionMode |
The mode control selects how the image data is converted from the sensor's native color into linear sRGB color. |
| ColorCorrectionTransform |
A color transform matrix to use to transform from sensor RGB color space to output linear sRGB color space. |
| ControlAeAntibandingMode |
The desired setting for the camera device's auto-exposure algorithm's antibanding compensation. |
| ControlAeExposureCompensation |
Adjustment to auto-exposure (AE) target image brightness. |
| ControlAeLock |
Whether auto-exposure (AE) is currently locked to its latest calculated values. |
| ControlAeMode |
The desired mode for the camera device's auto-exposure routine. |
| ControlAePrecaptureTrigger |
Whether the camera device will trigger a precapture metering sequence when it processes this request. |
| ControlAeRegions |
List of metering areas to use for auto-exposure adjustment. |
| ControlAeState |
Current state of the auto-exposure (AE) algorithm. |
| ControlAeTargetFpsRange |
Range over which the auto-exposure routine can adjust the capture frame rate to maintain good exposure. |
| ControlAfMode |
Whether auto-focus (AF) is currently enabled, and what mode it is set to. |
| ControlAfRegions |
List of metering areas to use for auto-focus. |
| ControlAfSceneChange |
Whether a significant scene change is detected within the currently-set AF region(s). |
| ControlAfState |
Current state of auto-focus (AF) algorithm. |
| ControlAfTrigger |
Whether the camera device will trigger autofocus for this request. |
| ControlAutoframing | |
| ControlAutoframingState | |
| ControlAwbLock |
Whether auto-white balance (AWB) is currently locked to its latest calculated values. |
| ControlAwbMode |
Whether auto-white balance (AWB) is currently setting the color transform fields, and what its illumination target is. |
| ControlAwbRegions |
List of metering areas to use for auto-white-balance illuminant estimation. |
| ControlAwbState |
Current state of auto-white balance (AWB) algorithm. |
| ControlCaptureIntent |
Information to the camera device 3A (auto-exposure, auto-focus, auto-white balance) routines about the purpose of this capture, to help the camera device to decide optimal 3A strategy. |
| ControlEffectMode |
A special color effect to apply. |
| ControlEnableZsl |
Allow camera device to enable zero-shutter-lag mode for requests with
|
| ControlExtendedSceneMode |
Whether extended scene mode is enabled for a particular capture request. |
| ControlMode |
Overall mode of 3A (auto-exposure, auto-white-balance, auto-focus) control routines. |
| ControlPostRawSensitivityBoost |
The amount of additional sensitivity boost applied to output images after RAW sensor data is captured. |
| ControlSceneMode |
Control for which scene mode is currently active. |
| ControlSettingsOverride | |
| ControlVideoStabilizationMode |
Whether video stabilization is active. |
| ControlZoomRatio |
The desired zoom ratio |
| DistortionCorrectionMode |
Mode of operation for the lens distortion correction block. |
| EdgeMode |
Operation mode for edge enhancement. |
| ExtensionCurrentType | |
| ExtensionStrength | |
| FlashMode |
The desired mode for for the camera device's flash control. |
| FlashState |
Current state of the flash unit. |
| FrameNumber |
Get the frame number associated with this result. |
| Handle |
The handle to the underlying Android instance. (Inherited from Object) |
| HotPixelMode |
Operational mode for hot pixel correction. |
| JniIdentityHashCode | (Inherited from Object) |
| JniPeerMembers | |
| JpegGpsLocation |
A location object to use when generating image GPS metadata. |
| JpegOrientation |
The orientation for a JPEG image. |
| JpegQuality |
Compression quality of the final JPEG image. |
| JpegThumbnailQuality |
Compression quality of JPEG thumbnail. |
| JpegThumbnailSize |
Resolution of embedded JPEG thumbnail. |
| Keys |
Returns a list of the keys contained in this map. (Inherited from CameraMetadata) |
| LensAperture |
The desired lens aperture size, as a ratio of lens focal length to the effective aperture diameter. |
| LensDistortion |
The correction coefficients to correct for this camera device's radial and tangential lens distortion. |
| LensFilterDensity |
The desired setting for the lens neutral density filter(s). |
| LensFocalLength |
The desired lens focal length; used for optical zoom. |
| LensFocusDistance |
Desired distance to plane of sharpest focus, measured from frontmost surface of the lens. |
| LensFocusRange |
The range of scene distances that are in sharp focus (depth of field). |
| LensIntrinsicCalibration |
The parameters for this camera device's intrinsic calibration. |
| LensOpticalStabilizationMode |
Sets whether the camera device uses optical image stabilization (OIS) when capturing images. |
| LensPoseRotation |
The orientation of the camera relative to the sensor coordinate system. |
| LensPoseTranslation |
Position of the camera optical center. |
| LensRadialDistortion |
The correction coefficients to correct for this camera device's radial and tangential lens distortion. |
| LensState |
Current lens status. |
| LogicalMultiCameraActivePhysicalId |
String containing the ID of the underlying active physical camera. |
| NoiseReductionMode |
Mode of operation for the noise reduction algorithm. |
| PeerReference | (Inherited from Object) |
| ReprocessEffectiveExposureFactor |
The amount of exposure time increase factor applied to the original output frame by the application processing before sending for reprocessing. |
| Request |
Get the request associated with this result. |
| RequestPipelineDepth |
Specifies the number of pipeline stages the frame went through from when it was exposed to when the final completed result was available to the framework. |
| ScalerCropRegion |
The desired region of the sensor to read out for this capture. |
| ScalerRawCropRegion | |
| ScalerRotateAndCrop |
Whether a rotation-and-crop operation is applied to processed outputs from the camera. |
| SensorDynamicBlackLevel |
A per-frame dynamic black level offset for each of the color filter arrangement (CFA) mosaic channels. |
| SensorDynamicWhiteLevel |
Maximum raw value output by sensor for this frame. |
| SensorExposureTime |
Duration each pixel is exposed to light. |
| SensorFrameDuration |
Duration from start of frame exposure to start of next frame exposure. |
| SensorGreenSplit |
The worst-case divergence between Bayer green channels. |
| SensorNeutralColorPoint |
The estimated camera neutral color in the native sensor colorspace at the time of capture. |
| SensorNoiseProfile |
Noise model coefficients for each CFA mosaic channel. |
| SensorPixelMode |
Switches sensor pixel mode between maximum resolution mode and default mode. |
| SensorRawBinningFactorUsed |
Whether <code>RAW</code> images requested have their bayer pattern as described by
|
| SensorRollingShutterSkew |
Duration between the start of exposure for the first row of the image sensor, and the start of exposure for one past the last row of the image sensor. |
| SensorSensitivity |
The amount of gain applied to sensor data before processing. |
| SensorTestPatternData |
A pixel <code>[R, G_even, G_odd, B]</code> that supplies the test pattern
when |
| SensorTestPatternMode |
When enabled, the sensor sends a test pattern instead of doing a real exposure from the camera. |
| SensorTimestamp |
Time at start of exposure of first row of the image sensor active array, in nanoseconds. |
| SequenceId |
The sequence ID for this failure that was returned by the
|
| ShadingMode |
Quality of lens shading correction applied to the image data. |
| StatisticsFaceDetectMode |
Operating mode for the face detector unit. |
| StatisticsFaces |
List of the faces detected through camera face detection in this capture. |
| StatisticsHotPixelMap |
List of <code>(x, y)</code> coordinates of hot/defective pixels on the sensor. |
| StatisticsHotPixelMapMode |
Operating mode for hot pixel map generation. |
| StatisticsLensShadingCorrectionMap |
The shading map is a low-resolution floating-point map that lists the coefficients used to correct for vignetting, for each Bayer color channel. |
| StatisticsLensShadingMapMode |
Whether the camera device will output the lens shading map in output result metadata. |
| StatisticsOisDataMode |
A control for selecting whether optical stabilization (OIS) position information is included in output result metadata. |
| StatisticsOisSamples |
An array of optical stabilization (OIS) position samples. |
| StatisticsSceneFlicker |
The camera device estimated scene illumination lighting frequency. |
| ThresholdClass |
This API supports the Mono for Android infrastructure and is not intended to be used directly from your code. |
| ThresholdType |
This API supports the Mono for Android infrastructure and is not intended to be used directly from your code. |
| TonemapCurve |
Tonemapping / contrast / gamma curve to use when |
| TonemapGamma |
Tonemapping curve to use when |
| TonemapMode |
High-level global contrast/gamma/tonemapping control. |
| TonemapPresetCurve |
Tonemapping curve to use when |
Methods
| Clone() |
Creates and returns a copy of this object. (Inherited from Object) |
| Dispose() | (Inherited from Object) |
| Dispose(Boolean) | (Inherited from Object) |
| Equals(Object) |
Indicates whether some other object is "equal to" this one. (Inherited from Object) |
| Get(CaptureResult+Key) |
Get a capture result field value. |
| GetHashCode() |
Returns a hash code value for the object. (Inherited from Object) |
| JavaFinalize() |
Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. (Inherited from Object) |
| Notify() |
Wakes up a single thread that is waiting on this object's monitor. (Inherited from Object) |
| NotifyAll() |
Wakes up all threads that are waiting on this object's monitor. (Inherited from Object) |
| SetHandle(IntPtr, JniHandleOwnership) |
Sets the Handle property. (Inherited from Object) |
| ToArray<T>() | (Inherited from Object) |
| ToString() |
Returns a string representation of the object. (Inherited from Object) |
| UnregisterFromRuntime() | (Inherited from Object) |
| Wait() |
Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>. (Inherited from Object) |
| Wait(Int64, Int32) |
Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object) |
| Wait(Int64) |
Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object) |
Explicit Interface Implementations
| IJavaPeerable.Disposed() | (Inherited from Object) |
| IJavaPeerable.DisposeUnlessReferenced() | (Inherited from Object) |
| IJavaPeerable.Finalized() | (Inherited from Object) |
| IJavaPeerable.JniManagedPeerState | (Inherited from Object) |
| IJavaPeerable.SetJniIdentityHashCode(Int32) | (Inherited from Object) |
| IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates) | (Inherited from Object) |
| IJavaPeerable.SetPeerReference(JniObjectReference) | (Inherited from Object) |
Extension Methods
| JavaCast<TResult>(IJavaObject) |
Performs an Android runtime-checked type conversion. |
| JavaCast<TResult>(IJavaObject) | |
| GetJniTypeName(IJavaPeerable) | |