CaptureResultMetadata

public interface CaptureResultMetadata extends Metadata, UnsafeWrapper

Known direct subclasses
CaptureResultWrapper

A wrapper interface providing compatibility-focused access to CaptureResult and custom metadata.
Known indirect subclasses
FakeCaptureResult

A fake implementation of CaptureResultWrapper for testing.

An interface that provides compatibility-focused, read-only query access to the results of a single image capture.

Use this interface to query the results of a single image capture, including sensor exposure, lens status, and 3A states. Implementing classes can abstract OS version differences and cache expensive-to-retrieve properties to ensure efficient access across all API levels.

CaptureResultMetadata extends Metadata, supporting type-safe retrieval of custom library-defined metadata keys via Metadata.Key in addition to native CaptureResult.Key keys (using get and getOrDefault).

CaptureResultMetadata is a superinterface of CaptureResultWrapper.

NOTE: This interface is not stable for inheritance. Do not implement this interface directly. For testing, use the fakes in the androidx.camera.common.testing package.

Example

Querying native and custom keys:

val result: CaptureResultMetadata = ...

// Query a native CaptureResult key:
val lensState: Int? = result[CaptureResult.LENS_STATE]

// Query a custom Metadata key:
val customKey = Metadata.Key<Int>("androidx.camera.custom_key")
val customValue: Int? = result[customKey]
See also
Metadata

Summary

Public methods
abstract T
<T extends Object> get(@NonNull CaptureResult.Key<@NonNull T> key)

Retrieves the value of the specified CaptureResult.Key.
default @NonNull T
<T extends Object> getOrDefault(
    @NonNull CaptureResult.Key<@NonNull T> key,
    @NonNull T default
)

Retrieves the value of the specified CaptureResult.Key, or returns default if the key is not present or its value is null.

Inherited methods
From androidx.camera.common.Metadata
abstract T
<T extends Object> get(@NonNull Metadata.Key<@NonNull T> key)

Retrieves the value associated with the specified Metadata.Key.
abstract @NonNull Set<@NonNull Metadata.Key<@NonNull ?>>

The set of all custom Metadata.Keys currently available in this container.
default @NonNull T
<T extends Object> getOrDefault(
    @NonNull Metadata.Key<@NonNull T> key,
    @NonNull T default
)

Retrieves the value associated with the specified Metadata.Key, or returns default if the key is not present.
From androidx.camera.common.UnsafeWrapper
abstract T
<T extends Object> unwrapAs(@NonNull Class<@NonNull T> type)

Attempts to unwrap this object into the specified underlying type.

Public methods

get

Added in 1.7.0-alpha03
abstract T <T extends Object> get(@NonNull CaptureResult.Key<@NonNull T> key)

Retrieves the value of the specified CaptureResult.Key.

Parameters
<T extends Object>

The type of the value (must be non-nullable).
@NonNull CaptureResult.Key<@NonNull T> key

The key to query.
Returns
T

The value of the key, or null if the key is not present or unsupported.

getOrDefault

Added in 1.7.0-alpha03
default @NonNull T <T extends Object> getOrDefault(
    @NonNull CaptureResult.Key<@NonNull T> key,
    @NonNull T default
)

Retrieves the value of the specified CaptureResult.Key, or returns default if the key is not present or its value is null.

Parameters
<T extends Object>

The type of the value (must be non-nullable).
@NonNull CaptureResult.Key<@NonNull T> key

The key to query.
@NonNull T default

The value to return if the key is not present or its value is null.
Returns
@NonNull T

The value of the key, or default if null.