CameraCaptureSession.CaptureCallback.OnCaptureProgressed Method
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.
This method is called when an image capture makes partial forward progress; some (but not all) results from an image capture are available.
[Android.Runtime.Register("onCaptureProgressed", "(Landroid/hardware/camera2/CameraCaptureSession;Landroid/hardware/camera2/CaptureRequest;Landroid/hardware/camera2/CaptureResult;)V", "GetOnCaptureProgressed_Landroid_hardware_camera2_CameraCaptureSession_Landroid_hardware_camera2_CaptureRequest_Landroid_hardware_camera2_CaptureResult_Handler")]
public virtual void OnCaptureProgressed (Android.Hardware.Camera2.CameraCaptureSession session, Android.Hardware.Camera2.CaptureRequest request, Android.Hardware.Camera2.CaptureResult partialResult);[<Android.Runtime.Register("onCaptureProgressed", "(Landroid/hardware/camera2/CameraCaptureSession;Landroid/hardware/camera2/CaptureRequest;Landroid/hardware/camera2/CaptureResult;)V", "GetOnCaptureProgressed_Landroid_hardware_camera2_CameraCaptureSession_Landroid_hardware_camera2_CaptureRequest_Landroid_hardware_camera2_CaptureResult_Handler")>]
abstract member OnCaptureProgressed : Android.Hardware.Camera2.CameraCaptureSession * Android.Hardware.Camera2.CaptureRequest * Android.Hardware.Camera2.CaptureResult -> unit
override this.OnCaptureProgressed : Android.Hardware.Camera2.CameraCaptureSession * Android.Hardware.Camera2.CaptureRequest * Android.Hardware.Camera2.CaptureResult -> unitParameters
- session
- CameraCaptureSession
the session returned by CameraDevice#createCaptureSession
- request
- CaptureRequest
The request that was given to the CameraDevice
- partialResult
- CaptureResult
The partial output metadata from the capture, which
includes a subset of the TotalCaptureResult fields.
- Attributes
Remarks
This method is called when an image capture makes partial forward progress; some (but not all) results from an image capture are available.
The result provided here will contain some subset of the fields of a full result. Multiple #onCaptureProgressed calls may happen per capture; a given result field will only be present in one partial capture at most. The final #onCaptureCompleted call will always contain all the fields (in particular, the union of all the fields of all the partial results composing the total result).
For each request, some result data might be available earlier than others. The typical delay between each partial result (per request) is a single frame interval. For performance-oriented use-cases, applications should query the metadata they need to make forward progress from the partial results and avoid waiting for the completed result.
For a particular request, #onCaptureProgressed may happen before or after #onCaptureStarted.
Each request will generate at least 1 partial results, and at most CameraCharacteristics#REQUEST_PARTIAL_RESULT_COUNT partial results.
Depending on the request settings, the number of partial results per request will vary, although typically the partial count could be the same as long as the camera device subsystems enabled stay the same.
The default implementation of this method does nothing.
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.