Camera2CameraInfo

Artifact: androidx.camera:camera-camera2

Added in 1.0.0

Kotlin |Java

@ExperimentalCamera2Interop
class Camera2CameraInfo

An interface for retrieving Camera2-related camera information.

Summary

Public functions
`java-static Camera2CameraInfo`	`from(cameraInfo: CameraInfo)` Gets the `Camera2CameraInfo` from a `CameraInfo`.
`T?`	`<T> getCameraCharacteristic(key: CameraCharacteristics.Key<T!>)` Gets a camera characteristic value.
`String`	`getCameraId()` Gets the string camera ID.

Public functions

from

Added in 1.0.0

java-static fun from(cameraInfo: CameraInfo): Camera2CameraInfo

Gets the Camera2CameraInfo from a CameraInfo.

If the CameraInfo is retrieved by an Extensions-enabled CameraSelector, calling getCameraCharacteristic will return any available Extensions-specific characteristics if exists.

Parameters
`cameraInfo: CameraInfo`	The `CameraInfo` to get from.

Returns
`Camera2CameraInfo`	The camera information with Camera2 implementation.

Throws
`java.lang.IllegalArgumentException`	if the camera info does not contain the camera2 information (e.g., if CameraX was not initialized with a `androidx.camera.camera2.Camera2Config`).

getCameraCharacteristic

Added in 1.0.0

fun <T> getCameraCharacteristic(key: CameraCharacteristics.Key<T!>): T?

Gets a camera characteristic value.

The characteristic value is the same as the value in the CameraCharacteristics that would be obtained from getCameraCharacteristics.

Parameters
`<T>`	The type of the characteristic value.
`key: CameraCharacteristics.Key<T!>`	The `CameraCharacteristics.Key` of the characteristic.

Returns
`T?`	the value of the characteristic.

getCameraId

Added in 1.0.0

fun getCameraId(): String

Gets the string camera ID.

The camera ID is the same as the camera ID that would be obtained from getCameraIdList. The ID that is retrieved is not static and can change depending on the current internal configuration of the androidx.camera.core.Camera from which the CameraInfo was retrieved. The Camera is a logical camera which can be backed by multiple android.hardware.camera2.CameraDevice. However, only one CameraDevice is active at one time. When the CameraDevice changes then the camera id will change.

Returns
`String`	the camera ID.

Throws
`java.lang.IllegalStateException`	if the camera info does not contain the camera 2 camera ID (e.g., if CameraX was not initialized with a `androidx.camera.camera2.Camera2Config`).