# CaptureRequestMetadata

Artifact: [androidx.camera:camera-common](https://developer.android.com/jetpack/androidx/releases/camera) [View Source](https://cs.android.com/search?q=file:androidx/camera/common/Metadata.kt+class:androidx.camera.common.CaptureRequestMetadata) Added in [1.7.0-rc02](https://developer.android.com/jetpack/androidx/releases/camera#1.7.0-rc02)

*** ** * ** ***


```
public interface CaptureRequestMetadata extends Metadata, UnsafeWrapper
```

<br />

Known direct subclasses [CaptureRequestWrapper](https://developer.android.com/reference/androidx/camera/common/CaptureRequestWrapper)

|---|---|
| `https://developer.android.com/reference/androidx/camera/common/CaptureRequestWrapper` | A wrapper interface representing the settings applied to a specific camera capture request. |

Known indirect subclasses [FakeCaptureRequest](https://developer.android.com/reference/androidx/camera/common/testing/FakeCaptureRequest)

|---|---|
| `https://developer.android.com/reference/androidx/camera/common/testing/FakeCaptureRequest` | A fake implementation of `https://developer.android.com/reference/androidx/camera/common/CaptureRequestWrapper` designed for unit testing. |

*** ** * ** ***

An interface that provides compatibility-focused, read-only query access to the settings applied to a camera capture request.

Use this interface to inspect the configuration parameters sent to the camera device during a capture session. Implementing classes can abstract OS version differences and cache expensive-to-retrieve properties to ensure efficient access across all API levels.

`CaptureRequestMetadata` extends `https://developer.android.com/reference/androidx/camera/common/Metadata`, supporting type-safe retrieval of custom library-defined metadata keys via `https://developer.android.com/reference/androidx/camera/common/Metadata.Key` in addition to native `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key.html` keys (using `https://developer.android.com/reference/androidx/camera/common/CaptureRequestMetadata#get(android.hardware.camera2.CaptureRequest.Key)` and `https://developer.android.com/reference/androidx/camera/common/CaptureRequestMetadata#getOrDefault(android.hardware.camera2.CaptureRequest.Key,kotlin.Any)`).

`CaptureRequestMetadata` is a superinterface of `https://developer.android.com/reference/androidx/camera/common/CaptureRequestWrapper`.

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 request: CaptureRequestMetadata = ...

// Query a native CaptureRequest key:
val exposureTime: Long? = request[CaptureRequest.SENSOR_EXPOSURE_TIME]

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

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/camera/common/Metadata` |   |

## Summary

| ### Public methods |
|---|---|
| `abstract T` | `<T extends https://developer.android.com/reference/java/lang/Object.html> https://developer.android.com/reference/androidx/camera/common/CaptureRequestMetadata#get(android.hardware.camera2.CaptureRequest.Key)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key.html<@https://developer.android.com/reference/androidx/annotation/NonNull T> key)` Retrieves the value of the specified `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key.html`. |
| `default @https://developer.android.com/reference/androidx/annotation/NonNull T` | `<T extends https://developer.android.com/reference/java/lang/Object.html> https://developer.android.com/reference/androidx/camera/common/CaptureRequestMetadata#getOrDefault(android.hardware.camera2.CaptureRequest.Key,kotlin.Any)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key.html<@https://developer.android.com/reference/androidx/annotation/NonNull T> key, @https://developer.android.com/reference/androidx/annotation/NonNull T default )` Retrieves the value of the specified `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key.html`, or returns `https://developer.android.com/reference/androidx/camera/common/CaptureRequestMetadata#getOrDefault(android.hardware.camera2.CaptureRequest.Key,kotlin.Any)` if the key is not present or its value is `null`. |

### Inherited methods

From [androidx.camera.common.Metadata](https://developer.android.com/reference/androidx/camera/common/Metadata) `abstract T` `<T extends https://developer.android.com/reference/java/lang/Object.html> https://developer.android.com/reference/androidx/camera/common/Metadata#get(androidx.camera.common.Metadata.Key)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/camera/common/Metadata.Key<@https://developer.android.com/reference/androidx/annotation/NonNull T> key)`

Retrieves the value associated with the specified `https://developer.android.com/reference/androidx/camera/common/Metadata.Key`.
`abstract @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/Set.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/camera/common/Metadata.Key<@https://developer.android.com/reference/androidx/annotation/NonNull ?>>` `https://developer.android.com/reference/androidx/camera/common/Metadata#getMetadataKeys()()`

The set of all custom `https://developer.android.com/reference/androidx/camera/common/Metadata.Key`s currently available in this container.
`default @https://developer.android.com/reference/androidx/annotation/NonNull T` `<T extends https://developer.android.com/reference/java/lang/Object.html> https://developer.android.com/reference/androidx/camera/common/Metadata#getOrDefault(androidx.camera.common.Metadata.Key,kotlin.Any)(
@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/camera/common/Metadata.Key<@https://developer.android.com/reference/androidx/annotation/NonNull T> key,
@https://developer.android.com/reference/androidx/annotation/NonNull T default
)`

Retrieves the value associated with the specified `https://developer.android.com/reference/androidx/camera/common/Metadata.Key`, or returns `https://developer.android.com/reference/androidx/camera/common/Metadata#getOrDefault(androidx.camera.common.Metadata.Key,kotlin.Any)` if the key is not present.
From [androidx.camera.common.UnsafeWrapper](https://developer.android.com/reference/androidx/camera/common/UnsafeWrapper) `abstract T` `<T extends https://developer.android.com/reference/java/lang/Object.html> https://developer.android.com/reference/androidx/camera/common/UnsafeWrapper#unwrapAs(java.lang.Class)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/Class.html<@https://developer.android.com/reference/androidx/annotation/NonNull T> type)`

Attempts to unwrap this object into the specified underlying `https://developer.android.com/reference/androidx/camera/common/UnsafeWrapper#unwrapAs(java.lang.Class)`.

## Public methods

### get

Added in [1.7.0-rc02](https://developer.android.com/jetpack/androidx/releases/camera#1.7.0-rc02)

```
abstract T <T extends Object> get(@NonNull CaptureRequest.Key<@NonNull T> key)
```

Retrieves the value of the specified `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key.html`.

| Parameters |
|---|---|
| `<T extends https://developer.android.com/reference/java/lang/Object.html>` | The type of the value (must be non-nullable). |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key.html<@https://developer.android.com/reference/androidx/annotation/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-rc02](https://developer.android.com/jetpack/androidx/releases/camera#1.7.0-rc02)

```
default @NonNull T <T extends Object> getOrDefault(
    @NonNull CaptureRequest.Key<@NonNull T> key,
    @NonNull T default
)
```

Retrieves the value of the specified `https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key.html`, or returns `https://developer.android.com/reference/androidx/camera/common/CaptureRequestMetadata#getOrDefault(android.hardware.camera2.CaptureRequest.Key,kotlin.Any)` if the key is not present or its value is `null`.

| Parameters |
|---|---|
| `<T extends https://developer.android.com/reference/java/lang/Object.html>` | The type of the value (must be non-nullable). |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Key.html<@https://developer.android.com/reference/androidx/annotation/NonNull T> key` | The key to query. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull T default` | The value to return if the key is not present or is `null`. |

| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull T` | The value of the key, or `https://developer.android.com/reference/androidx/camera/common/CaptureRequestMetadata#getOrDefault(android.hardware.camera2.CaptureRequest.Key,kotlin.Any)` if the key is not present or its value is `null`. |