TotalCaptureResult 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 total assembled results of a single image capture from the image sensor.
[Android.Runtime.Register("android/hardware/camera2/TotalCaptureResult", DoNotGenerateAcw=true)]
public sealed class TotalCaptureResult : Android.Hardware.Camera2.CaptureResult[<Android.Runtime.Register("android/hardware/camera2/TotalCaptureResult", DoNotGenerateAcw=true)>]
type TotalCaptureResult = class
inherit CaptureResult- Inheritance
- Attributes
Remarks
The total assembled results of a single image capture from the image sensor.
Contains the final configuration for the capture hardware (sensor, lens, flash), the processing pipeline, the control algorithms, and the output buffers.
A TotalCaptureResult is 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.
All properties returned by CameraCharacteristics#getAvailableCaptureResultKeys() are available (that is CaptureResult#get will return non-null, if and only if that key that was enabled by the request. A few keys such as CaptureResult#STATISTICS_FACES are disabled by default unless enabled with a switch (such as CaptureRequest#STATISTICS_FACE_DETECT_MODE). Refer to each key documentation on a case-by-case basis.
For a logical multi-camera device, if the CaptureRequest contains a surface for an underlying physical camera, the corresponding TotalCaptureResult object will include the metadata for that physical camera. And the mapping between the physical camera id and result metadata can be accessed via #getPhysicalCameraResults. If all requested surfaces are for the logical camera, no metadata for physical camera will be included.
TotalCaptureResult objects are immutable.
Java documentation for android.hardware.camera2.TotalCaptureResult.
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.
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
| CameraId |
Get the camera ID of the camera that produced this capture result. (Inherited from CaptureResult) |
| Class |
Returns the runtime class of this |
| FrameNumber |
Get the frame number associated with this result. (Inherited from CaptureResult) |
| Handle |
The handle to the underlying Android instance. (Inherited from Object) |
| JniIdentityHashCode | (Inherited from Object) |
| JniPeerMembers | |
| Keys |
Returns a list of the keys contained in this map. (Inherited from CameraMetadata) |
| PartialResults |
Get the read-only list of partial results that compose this total result. |
| PeerReference | (Inherited from Object) |
| PhysicalCameraResults |
Get the map between physical camera ids and their capture result metadata |
| PhysicalCameraTotalResults |
Get the map between physical camera ids and their total capture result metadata |
| Request |
Get the request associated with this result. (Inherited from CaptureResult) |
| SequenceId |
The sequence ID for this failure that was returned by the
|
| ThresholdClass |
This API supports the Mono for Android infrastructure and is not intended to be used directly from your code. (Inherited from CaptureResult) |
| ThresholdType |
This API supports the Mono for Android infrastructure and is not intended to be used directly from your code. (Inherited from CaptureResult) |
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. (Inherited from CaptureResult) |
| 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) |
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, 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) |
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) | |