CaptureResultWrappers

Kotlin |Java

public static class CaptureResultWrappers

Helper utilities for constructing and wrapping CaptureResultWrapper instances.

Summary

Public fields
`static @NonNull CaptureResultWrappers`	`INSTANCE`

Public methods
`static final @NonNull CaptureResultWrapper`	`wrap( @NonNull CaptureResult captureResult, @NonNull CameraId cameraId, @NonNull CaptureRequestWrapper captureRequest, @NonNull Map<@NonNull Metadata.Key<@NonNull ?>, Object> metadata )` Wraps a native `CaptureResult` into a `CaptureResultWrapper`.

Public fields

INSTANCE

Added in 1.7.0-rc01

public static @NonNull CaptureResultWrappers INSTANCE

Public methods

wrap

Added in 1.7.0-rc01

public static final @NonNull CaptureResultWrapper wrap(
    @NonNull CaptureResult captureResult,
    @NonNull CameraId cameraId,
    @NonNull CaptureRequestWrapper captureRequest,
    @NonNull Map<@NonNull Metadata.Key<@NonNull ?>, Object> metadata
)

Wraps a native CaptureResult into a CaptureResultWrapper.

import androidx.camera.common.CameraId
import androidx.camera.common.CaptureRequestWrappers
import androidx.camera.common.CaptureResultWrapper
import androidx.camera.common.CaptureResultWrappers

val cameraId = CameraId("0")
val captureRequest = CaptureRequestWrappers.wrap(captureResult.request)

// Wrap a native CaptureResult into a CaptureResultWrapper.
val resultWrapper: CaptureResultWrapper =
    CaptureResultWrappers.wrap(
        captureResult = captureResult,
        cameraId = cameraId,
        captureRequest = captureRequest,
    )

// Query standard Camera2 result keys:
val lensState = resultWrapper[CaptureResult.LENS_STATE]
val frameNumber = resultWrapper.frameNumber
val originatingRequest = resultWrapper.captureRequest

Parameters
`@NonNull CaptureResult captureResult`	the native `CaptureResult` to wrap.
`@NonNull CameraId cameraId`	the `CameraId` of the camera device that produced the result.
`@NonNull CaptureRequestWrapper captureRequest`	the `CaptureRequestWrapper` representing the request that produced this result.
`@NonNull Map<@NonNull Metadata.Key<@NonNull ?>, Object> metadata`	optional map of custom `Metadata.Key` values to attach to the wrapper.

Returns
`@NonNull CaptureResultWrapper`	a `CaptureResultWrapper` wrapping the given `captureResult` and metadata.