CameraCharacteristicsMetadata

interface CameraCharacteristicsMetadata : Metadata, UnsafeWrapper

Known direct subclasses
CameraCharacteristicsWrapper

Wrapper interface providing compatibility-focused access to CameraCharacteristics.
CameraExtensionCharacteristicsWrapper

Compatibility wrapper around CameraExtensionCharacteristics.
Known indirect subclasses

An interface that provides compatibility-focused, read-only query access to CameraCharacteristics.

Use this interface to query camera capabilities, physical properties, and supported configurations. Implementing classes can abstract OS version differences and cache expensive-to-retrieve properties to ensure efficient access across all API levels.

CameraCharacteristicsMetadata extends Metadata, supporting type-safe retrieval of custom library-defined metadata keys via Metadata.Key in addition to native CameraCharacteristics.Key keys.

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 characteristics: CameraCharacteristicsMetadata = ...

// Query a native CameraCharacteristics key:
val lensFacing: Int? = characteristics[CameraCharacteristics.LENS_FACING]

// Query a custom Metadata key:
val customValue: String? = characteristics[MY_CUSTOM_METADATA_KEY]

Summary

Public functions
operator T?

Retrieves the value of the specified CameraCharacteristics.Key.
open T
<T : Any> getOrDefault(key: CameraCharacteristics.Key<T>, default: T)

Retrieves the value of the specified CameraCharacteristics.Key, or returns default if the value is null or the key is unsupported.

Inherited functions
From androidx.camera.common.Metadata
operator T?
<T : Any> get(key: Metadata.Key<T>)

Retrieves the value associated with the specified Metadata.Key.
open T
<T : Any> getOrDefault(key: Metadata.Key<T>, default: T)

Retrieves the value associated with the specified Metadata.Key, or returns default if the key is not present.
From androidx.camera.common.UnsafeWrapper
T?
<T : Any> unwrapAs(type: Class<T>)

Attempts to unwrap this object into the specified underlying type.

Inherited properties
From androidx.camera.common.Metadata
Set<Metadata.Key<*>>

The set of all custom Metadata.Keys currently available in this container.

Public functions

get

Added in 1.7.0-alpha03
operator fun <T : Any> get(key: CameraCharacteristics.Key<T>): T?

Retrieves the value of the specified CameraCharacteristics.Key.

Parameters
<T : Any>

The type of the value (must be non-nullable).
key: CameraCharacteristics.Key<T>

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
open fun <T : Any> getOrDefault(key: CameraCharacteristics.Key<T>, default: T): T

Retrieves the value of the specified CameraCharacteristics.Key, or returns default if the value is null or the key is unsupported.

Parameters
<T : Any>

The type of the value (must be non-nullable).
key: CameraCharacteristics.Key<T>

The key to query.
default: T

The value to return if the key is not present or unsupported.
Returns
T

The value of the key, or default if null.