CaptureRequestWrappers

Kotlin |Java

object CaptureRequestWrappers

Helper utilities for constructing and wrapping CaptureRequestWrapper instances.

Summary

Public functions
`CaptureRequestWrapper`	`wrap(captureRequest: CaptureRequest, metadata: Map<Metadata.Key<*>, Any?>)` Wraps a native `CaptureRequest` and optional custom metadata into a `CaptureRequestWrapper`.

Public functions

wrap

fun wrap(
    captureRequest: CaptureRequest,
    metadata: Map<Metadata.Key<*>, Any?> = emptyMap()
): CaptureRequestWrapper

Wraps a native CaptureRequest and optional custom metadata into a CaptureRequestWrapper.

import androidx.camera.common.CaptureRequestWrapper
import androidx.camera.common.CaptureRequestWrappers
import androidx.camera.common.Metadata

// Wrap a native CaptureRequest into a CaptureRequestWrapper.
val requestWrapper: CaptureRequestWrapper = CaptureRequestWrappers.wrap(captureRequest)

// Query native Camera2 CaptureRequest keys:
val aeMode = requestWrapper[CaptureRequest.CONTROL_AE_MODE]

// Or attach custom library/application metadata to the request:
val customKey = Metadata.Key<String>("com.example.custom_request_tag")
val requestWithMetadata =
    CaptureRequestWrappers.wrap(
        captureRequest,
        metadata = mapOf(customKey to "sample_tag_value"),
    )
val customTagValue = requestWithMetadata[customKey]

Parameters
`captureRequest: CaptureRequest`	the native `CaptureRequest` to wrap.
`metadata: Map<Metadata.Key<*>, Any?> = emptyMap()`	optional map of custom `Metadata.Key` values to attach to the wrapper.

Returns
`CaptureRequestWrapper`	a `CaptureRequestWrapper` wrapping the given `captureRequest` and `metadata`.