CameraExtensionCharacteristicsWrappers

Artifact: androidx.camera:camera-common

View Source

Added in 1.7.0-alpha03

---

Kotlin |Java

object CameraExtensionCharacteristicsWrappers

---

Helper for constructing and loading CameraExtensionCharacteristicsWrapper instances.

Summary

Public functions
Map<Int, CameraExtensionCharacteristicsWrapper>	loadAvailableExtensionsFrom(     cameraManager: CameraManager,     cameraId: CameraId ) Loads and wraps CameraExtensionCharacteristicsWrapper instances for all supported extension modes on the given camera ID using the CameraManager.
Map<Int, CameraExtensionCharacteristicsWrapper>	loadAvailableExtensionsFrom(context: Context, cameraId: CameraId) Loads and wraps CameraExtensionCharacteristicsWrapper instances for all supported extension modes on the given camera ID using the Context.
CameraExtensionCharacteristicsWrapper?	loadFrom(     cameraManager: CameraManager,     cameraId: CameraId,     cameraExtension: Int ) Loads and wraps CameraExtensionCharacteristicsWrapper for the given camera ID and extension mode using the CameraManager.
CameraExtensionCharacteristicsWrapper?	loadFrom(context: Context, cameraId: CameraId, cameraExtension: Int) Loads and wraps CameraExtensionCharacteristicsWrapper for the given camera ID and extension mode using the Context.
CameraExtensionCharacteristicsWrapper	@RequiresApi(value = 31) wrap(     cameraId: CameraId,     cameraExtension: Int,     extensionCharacteristics: CameraExtensionCharacteristics,     isRestricted: Boolean ) Wraps an existing CameraExtensionCharacteristics instance.

Public functions

loadAvailableExtensionsFrom

Added in 1.7.0-alpha03

fun loadAvailableExtensionsFrom(
    cameraManager: CameraManager,
    cameraId: CameraId
): Map<Int, CameraExtensionCharacteristicsWrapper>

Loads and wraps CameraExtensionCharacteristicsWrapper instances for all supported extension modes on the given camera ID using the CameraManager.

Returns an empty map if the API level is less than 31.

Parameters
cameraManager: CameraManager	the system camera manager.
cameraId: CameraId	the ID of the camera device.

Returns
Map<Int, CameraExtensionCharacteristicsWrapper>	a map of CameraExtension mode to CameraExtensionCharacteristicsWrapper.

loadAvailableExtensionsFrom

Added in 1.7.0-alpha03

fun loadAvailableExtensionsFrom(context: Context, cameraId: CameraId): Map<Int, CameraExtensionCharacteristicsWrapper>

Loads and wraps CameraExtensionCharacteristicsWrapper instances for all supported extension modes on the given camera ID using the Context.

Returns an empty map if the API level is less than 31.

Parameters
context: Context	the application context.
cameraId: CameraId	the ID of the camera device.

Returns
Map<Int, CameraExtensionCharacteristicsWrapper>	a map of CameraExtension mode to CameraExtensionCharacteristicsWrapper.

loadFrom

Added in 1.7.0-alpha03

fun loadFrom(
    cameraManager: CameraManager,
    cameraId: CameraId,
    cameraExtension: Int
): CameraExtensionCharacteristicsWrapper?

Loads and wraps CameraExtensionCharacteristicsWrapper for the given camera ID and extension mode using the CameraManager.

Returns null if the API level is less than 31 or if the extension is not supported by the camera device.

Parameters
cameraManager: CameraManager	the system camera manager.
cameraId: CameraId	the ID of the camera device.
cameraExtension: Int	the camera extension mode.

Returns
CameraExtensionCharacteristicsWrapper?	a CameraExtensionCharacteristicsWrapper instance, or null if unsupported.

loadFrom

Added in 1.7.0-alpha03

fun loadFrom(context: Context, cameraId: CameraId, cameraExtension: Int): CameraExtensionCharacteristicsWrapper?

Loads and wraps CameraExtensionCharacteristicsWrapper for the given camera ID and extension mode using the Context.

Returns null if the API level is less than 31 or if the extension is not supported by the camera device.

Parameters
context: Context	the application context.
cameraId: CameraId	the ID of the camera device.
cameraExtension: Int	the camera extension mode.

Returns
CameraExtensionCharacteristicsWrapper?	a CameraExtensionCharacteristicsWrapper instance, or null if unsupported.

wrap

Added in 1.7.0-alpha03

@RequiresApi(value = 31)
fun wrap(
    cameraId: CameraId,
    cameraExtension: Int,
    extensionCharacteristics: CameraExtensionCharacteristics,
    isRestricted: Boolean = false
): CameraExtensionCharacteristicsWrapper

Wraps an existing CameraExtensionCharacteristics instance.

Parameters
cameraId: CameraId	the ID of the camera device.
cameraExtension: Int	the camera extension mode.
extensionCharacteristics: CameraExtensionCharacteristics	the native camera extension characteristics instance.
isRestricted: Boolean = false	whether access to some characteristics keys is restricted.

Returns
CameraExtensionCharacteristicsWrapper	a CameraExtensionCharacteristicsWrapper instance wrapping the native object.