CameraExtensionCharacteristicsWrappers

Artifact: androidx.camera:camera-common

View Source

Added in 1.7.0-alpha03

---

Kotlin |Java

public static class CameraExtensionCharacteristicsWrappers

---

Helper for constructing and loading CameraExtensionCharacteristicsWrapper instances.

Summary

Public fields
static @NonNull CameraExtensionCharacteristicsWrappers	INSTANCE

Public methods
static final @NonNull Map<@NonNull Integer, @NonNull CameraExtensionCharacteristicsWrapper>	loadAvailableExtensionsFrom(     @NonNull CameraManager cameraManager,     @NonNull CameraId cameraId ) Loads and wraps CameraExtensionCharacteristicsWrapper instances for all supported extension modes on the given camera ID using the CameraManager.
static final @NonNull Map<@NonNull Integer, @NonNull CameraExtensionCharacteristicsWrapper>	loadAvailableExtensionsFrom(     @NonNull Context context,     @NonNull CameraId cameraId ) Loads and wraps CameraExtensionCharacteristicsWrapper instances for all supported extension modes on the given camera ID using the Context.
static final CameraExtensionCharacteristicsWrapper	loadFrom(     @NonNull CameraManager cameraManager,     @NonNull CameraId cameraId,     int cameraExtension ) Loads and wraps CameraExtensionCharacteristicsWrapper for the given camera ID and extension mode using the CameraManager.
static final CameraExtensionCharacteristicsWrapper	loadFrom(     @NonNull Context context,     @NonNull CameraId cameraId,     int cameraExtension ) Loads and wraps CameraExtensionCharacteristicsWrapper for the given camera ID and extension mode using the Context.
static final @NonNull CameraExtensionCharacteristicsWrapper	@RequiresApi(value = 31) wrap(     @NonNull CameraId cameraId,     int cameraExtension,     @NonNull CameraExtensionCharacteristics extensionCharacteristics,     boolean isRestricted ) Wraps an existing CameraExtensionCharacteristics instance.

Public fields

INSTANCE

Added in 1.7.0-alpha03

public static @NonNull CameraExtensionCharacteristicsWrappers INSTANCE

Public methods

loadAvailableExtensionsFrom

Added in 1.7.0-alpha03

public static final @NonNull Map<@NonNull Integer, @NonNull CameraExtensionCharacteristicsWrapper> loadAvailableExtensionsFrom(
    @NonNull CameraManager cameraManager,
    @NonNull CameraId cameraId
)

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
@NonNull CameraManager cameraManager	the system camera manager.
@NonNull CameraId cameraId	the ID of the camera device.

Returns
@NonNull Map<@NonNull Integer, @NonNull CameraExtensionCharacteristicsWrapper>	a map of CameraExtension mode to CameraExtensionCharacteristicsWrapper.

loadAvailableExtensionsFrom

Added in 1.7.0-alpha03

public static final @NonNull Map<@NonNull Integer, @NonNull CameraExtensionCharacteristicsWrapper> loadAvailableExtensionsFrom(
    @NonNull Context context,
    @NonNull CameraId cameraId
)

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
@NonNull Context context	the application context.
@NonNull CameraId cameraId	the ID of the camera device.

Returns
@NonNull Map<@NonNull Integer, @NonNull CameraExtensionCharacteristicsWrapper>	a map of CameraExtension mode to CameraExtensionCharacteristicsWrapper.

loadFrom

Added in 1.7.0-alpha03

public static final CameraExtensionCharacteristicsWrapper loadFrom(
    @NonNull CameraManager cameraManager,
    @NonNull CameraId cameraId,
    int cameraExtension
)

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
@NonNull CameraManager cameraManager	the system camera manager.
@NonNull CameraId cameraId	the ID of the camera device.
int cameraExtension	the camera extension mode.

Returns
CameraExtensionCharacteristicsWrapper	a CameraExtensionCharacteristicsWrapper instance, or null if unsupported.

loadFrom

Added in 1.7.0-alpha03

public static final CameraExtensionCharacteristicsWrapper loadFrom(
    @NonNull Context context,
    @NonNull CameraId cameraId,
    int cameraExtension
)

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
@NonNull Context context	the application context.
@NonNull CameraId cameraId	the ID of the camera device.
int cameraExtension	the camera extension mode.

Returns
CameraExtensionCharacteristicsWrapper	a CameraExtensionCharacteristicsWrapper instance, or null if unsupported.

wrap

Added in 1.7.0-alpha03

@RequiresApi(value = 31)
public static final @NonNull CameraExtensionCharacteristicsWrapper wrap(
    @NonNull CameraId cameraId,
    int cameraExtension,
    @NonNull CameraExtensionCharacteristics extensionCharacteristics,
    boolean isRestricted
)

Wraps an existing CameraExtensionCharacteristics instance.

Parameters
@NonNull CameraId cameraId	the ID of the camera device.
int cameraExtension	the camera extension mode.
@NonNull CameraExtensionCharacteristics extensionCharacteristics	the native camera extension characteristics instance.
boolean isRestricted	whether access to some characteristics keys is restricted.

Returns
@NonNull CameraExtensionCharacteristicsWrapper	a CameraExtensionCharacteristicsWrapper instance wrapping the native object.