CameraManager

getCameraCharacteristics

fun getCameraCharacteristics(cameraId: String): CameraCharacteristics

Query the capabilities of a camera device. These capabilities are immutable for a given camera.

From API level 29, this function can also be used to query the capabilities of physical cameras that can only be used as part of logical multi-camera. These cameras cannot be opened directly via #openCamera

Also starting with API level 29, while most basic camera information is still available even without the CAMERA permission, some values are not available to apps that do not hold that permission. The keys not available are listed by CameraCharacteristics.getKeysNeedingPermission.

getCameraDeviceSetup

fun getCameraDeviceSetup(cameraId: String): CameraDevice.CameraDeviceSetup

Returns a CameraDevice.CameraDeviceSetup object for the given cameraId, which provides limited access to CameraDevice setup and query functionality without requiring an #openCamera call. The CameraDevice can later be obtained either by calling #openCamera, or CameraDevice.CameraDeviceSetup.openCamera.

Support for CameraDevice.CameraDeviceSetup for a given cameraId must be checked with isCameraDeviceSetupSupported. If isCameraDeviceSetupSupported returns false for a cameraId, this method will throw an UnsupportedOperationException

getCameraExtensionCharacteristics

fun getCameraExtensionCharacteristics(cameraId: String): CameraExtensionCharacteristics

Query the camera extension capabilities of a camera device.

getCameraIdList

fun getCameraIdList(): Array<String!>

Return the list of currently connected camera devices by identifier, including cameras that may be in use by other camera API clients.

Non-removable cameras use integers starting at 0 for their identifiers, while removable cameras have a unique identifier for each individual device, even if they are the same model.

This list doesn't contain physical cameras that can only be used as part of a logical multi-camera device.

getConcurrentCameraIds

fun getConcurrentCameraIds(): MutableSet<MutableSet<String!>!>

Return the set of combinations of currently connected camera device identifiers, which support configuring camera device sessions concurrently.

The devices in these combinations can be concurrently configured by the same client camera application. Using these camera devices concurrently by two different applications is not guaranteed to be supported, however.

For concurrent operation, in chronological order :

• Applications must first close any open cameras that have sessions configured, using CameraDevice.close.
• All camera devices intended to be operated concurrently, must be opened using #openCamera, before configuring sessions on any of the camera devices.

Each device in a combination, is guaranteed to support stream combinations which may be obtained by querying getCameraCharacteristics for the key android.hardware.camera2.CameraCharacteristics#SCALER_MANDATORY_CONCURRENT_STREAM_COMBINATIONS.

For concurrent operation, if a camera device has a non null zoom ratio range as specified by android.hardware.camera2.CameraCharacteristics#CONTROL_ZOOM_RATIO_RANGE, its complete zoom ratio range may not apply. Applications can use android.hardware.camera2.CaptureRequest#CONTROL_ZOOM_RATIO >=1 and <= android.hardware.camera2.CameraCharacteristics#SCALER_AVAILABLE_MAX_DIGITAL_ZOOM during concurrent operation.

The set of combinations may include camera devices that may be in use by other camera API clients.

Concurrent camera extension sessions CameraExtensionSession are not currently supported.

The set of combinations doesn't contain physical cameras that can only be used as part of a logical multi-camera device.

If a new camera id becomes available through AvailabilityCallback.onCameraUnavailable(String), clients can call this method to check if new combinations of camera ids which can stream concurrently are available.

getTorchStrengthLevel

fun getTorchStrengthLevel(cameraId: String): Int

Returns the brightness level of the flash unit associated with the cameraId.

isCameraDeviceSetupSupported

fun isCameraDeviceSetupSupported(cameraId: String): Boolean

Checks a Camera Device's characteristics to ensure that a CameraDevice.CameraDeviceSetup instance can be constructed for a given cameraId. If this method returns false for a cameraId, calling getCameraDeviceSetup for that cameraId will throw an UnsupportedOperationException.

CameraDevice.CameraDeviceSetup is supported for all devices that report CameraCharacteristics.INFO_SESSION_CONFIGURATION_QUERY_VERSION > android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE

isConcurrentSessionConfigurationSupported

fun isConcurrentSessionConfigurationSupported(cameraIdAndSessionConfig: MutableMap<String!, SessionConfiguration!>): Boolean

Checks whether the provided set of camera devices and their corresponding SessionConfiguration can be configured concurrently.

This method performs a runtime check of the given SessionConfiguration and camera id combinations. The result confirms whether or not the passed session configurations can be successfully used to create camera capture sessions concurrently, on the given camera devices using CameraDevice.createCaptureSession(SessionConfiguration).

The method can be called at any point before, during and after active capture sessions. It will not impact normal camera behavior in any way and must complete significantly faster than creating a regular or constrained capture session.

Although this method is faster than creating a new capture session, it is not intended to be used for exploring the entire space of supported concurrent stream combinations. The available mandatory concurrent stream combinations may be obtained by querying getCameraCharacteristics for the key android.hardware.camera2.CameraCharacteristics#SCALER_MANDATORY_CONCURRENT_STREAM_COMBINATIONS.

Note that session parameters will be ignored and calls to SessionConfiguration.setSessionParameters are not required.

openCamera

fun openCamera(
    cameraId: String, 
    callback: CameraDevice.StateCallback, 
    handler: Handler?
): Unit

Open a connection to a camera with the given ID.

Use getCameraIdList to get the list of available camera devices. Note that even if an id is listed, open may fail if the device is disconnected between the calls to getCameraIdList and #openCamera, or if a higher-priority camera API client begins using the camera device.

As of API level 23, devices for which the AvailabilityCallback.onCameraUnavailable(String) callback has been called due to the device being in use by a lower-priority, background camera API client can still potentially be opened by calling this method when the calling camera API client has a higher priority than the current camera API client using this device. In general, if the top, foreground activity is running within your application process, your process will be given the highest priority when accessing the camera, and this method will succeed even if the camera device is in use by another camera API client. Any lower-priority application that loses control of the camera in this way will receive an android.hardware.camera2.CameraDevice.StateCallback#onDisconnected callback. Opening the same camera ID twice in the same application will similarly cause the android.hardware.camera2.CameraDevice.StateCallback#onDisconnected callback being fired for the CameraDevice from the first open call and all ongoing tasks being dropped.

Once the camera is successfully opened, CameraDevice.StateCallback.onOpened will be invoked with the newly opened CameraDevice. The camera device can then be set up for operation by calling android.hardware.camera2.CameraDevice#createCaptureSession and android.hardware.camera2.CameraDevice#createCaptureRequest

Before API level 30, when the application tries to open multiple CameraDevice of different IDs and the device does not support opening such combination, either the #openCamera will fail and throw a CameraAccessException or one or more of already opened CameraDevice will be disconnected and receive android.hardware.camera2.CameraDevice.StateCallback#onDisconnected callback. Which behavior will happen depends on the device implementation and can vary on different devices. Starting in API level 30, if the device does not support the combination of cameras being opened, it is guaranteed the #openCamera call will fail and none of existing CameraDevice will be disconnected.

If the camera becomes disconnected during initialization after this function call returns, CameraDevice.StateCallback.onDisconnected with a CameraDevice in the disconnected state (and CameraDevice.StateCallback.onOpened will be skipped).

If opening the camera device fails, then the device callback's onError method will be called, and subsequent calls on the camera device will throw a CameraAccessException.

openCamera

fun openCamera(
    cameraId: String, 
    executor: Executor, 
    callback: CameraDevice.StateCallback
): Unit

Open a connection to a camera with the given ID.

The behavior of this method matches that of openCamera(java.lang.String,android.hardware.camera2.CameraDevice.StateCallback,android.os.Handler), except that it uses java.util.concurrent.Executor as an argument instead of android.os.Handler.

Do note that typically callbacks are expected to be dispatched by the executor in a single thread. If the executor uses two or more threads to dispatch callbacks, then clients must ensure correct synchronization and must also be able to handle potentially different ordering of the incoming callbacks.

registerAvailabilityCallback

fun registerAvailabilityCallback(
    callback: CameraManager.AvailabilityCallback, 
    handler: Handler?
): Unit

Register a callback to be notified about camera device availability.

Registering the same callback again will replace the handler with the new one provided.

The first time a callback is registered, it is immediately called with the availability status of all currently known camera devices.

AvailabilityCallback.onCameraUnavailable(String) will be called whenever a camera device is opened by any camera API client. As of API level 23, other camera API clients may still be able to open such a camera device, evicting the existing client if they have higher priority than the existing client of a camera device. See open() for more details.

Since this callback will be registered with the camera service, remember to unregister it once it is no longer needed; otherwise the callback will continue to receive events indefinitely and it may prevent other resources from being released. Specifically, the callbacks will be invoked independently of the general activity lifecycle and independently of the state of individual CameraManager instances.

registerAvailabilityCallback

fun registerAvailabilityCallback(
    executor: Executor, 
    callback: CameraManager.AvailabilityCallback
): Unit

Register a callback to be notified about camera device availability.

The behavior of this method matches that of registerAvailabilityCallback(android.hardware.camera2.CameraManager.AvailabilityCallback,android.os.Handler), except that it uses java.util.concurrent.Executor as an argument instead of android.os.Handler.

Note: If the order between some availability callbacks matters, the implementation of the executor should handle those callbacks in the same thread to maintain the callbacks' order. Some examples are:

• AvailabilityCallback.onCameraAvailable and AvailabilityCallback.onCameraUnavailable of the same camera ID.
• AvailabilityCallback.onCameraAvailable or AvailabilityCallback.onCameraUnavailable of a logical multi-camera, and android.hardware.camera2.CameraManager.AvailabilityCallback#onPhysicalCameraUnavailable or AvailabilityCallback.onPhysicalCameraAvailable of its physical cameras.

registerTorchCallback

fun registerTorchCallback(
    callback: CameraManager.TorchCallback, 
    handler: Handler?
): Unit

Register a callback to be notified about torch mode status.

Registering the same callback again will replace the handler with the new one provided.

The first time a callback is registered, it is immediately called with the torch mode status of all currently known camera devices with a flash unit.

Since this callback will be registered with the camera service, remember to unregister it once it is no longer needed; otherwise the callback will continue to receive events indefinitely and it may prevent other resources from being released. Specifically, the callbacks will be invoked independently of the general activity lifecycle and independently of the state of individual CameraManager instances.

registerTorchCallback

fun registerTorchCallback(
    executor: Executor, 
    callback: CameraManager.TorchCallback
): Unit

Register a callback to be notified about torch mode status.

The behavior of this method matches that of registerTorchCallback(android.hardware.camera2.CameraManager.TorchCallback,android.os.Handler), except that it uses java.util.concurrent.Executor as an argument instead of android.os.Handler.

setTorchMode

fun setTorchMode(
    cameraId: String, 
    enabled: Boolean
): Unit

Set the flash unit's torch mode of the camera of the given ID without opening the camera device.

Use getCameraIdList to get the list of available camera devices and use getCameraCharacteristics to check whether the camera device has a flash unit. Note that even if a camera device has a flash unit, turning on the torch mode may fail if the camera device or other camera resources needed to turn on the torch mode are in use.

If setTorchMode is called to turn on or off the torch mode successfully, CameraManager.TorchCallback.onTorchModeChanged will be invoked. However, even if turning on the torch mode is successful, the application does not have the exclusive ownership of the flash unit or the camera device. The torch mode will be turned off and becomes unavailable when the camera device that the flash unit belongs to becomes unavailable or when other camera resources to keep the torch on become unavailable ( CameraManager.TorchCallback.onTorchModeUnavailable will be invoked). Also, other applications are free to call setTorchMode to turn off the torch mode ( CameraManager.TorchCallback.onTorchModeChanged will be invoked). If the latest application that turned on the torch mode exits, the torch mode will be turned off.

turnOnTorchWithStrengthLevel

fun turnOnTorchWithStrengthLevel(
    cameraId: String, 
    torchStrength: Int
): Unit

Set the brightness level of the flashlight associated with the given cameraId in torch mode. If the torch is OFF and torchStrength is >= 1, torch will turn ON with the strength level specified in torchStrength.

Use android.hardware.camera2.CameraCharacteristics#FLASH_INFO_STRENGTH_MAXIMUM_LEVEL to check whether the camera device supports flash unit strength control or not. If this value is greater than 1, applications can call this API to control the flashlight brightness level.

If turnOnTorchWithStrengthLevel is called to change the brightness level of the flash unit CameraManager.TorchCallback.onTorchStrengthLevelChanged will be invoked. If the new desired strength level is same as previously set level, then this callback will not be invoked. If the torch is OFF and turnOnTorchWithStrengthLevel is called with level >= 1, the torch will be turned ON with that brightness level. In this case CameraManager.TorchCallback.onTorchModeChanged will also be invoked.

When the torch is turned OFF via setTorchMode, the flashlight brightness level will reset to default value android.hardware.camera2.CameraCharacteristics#FLASH_INFO_STRENGTH_DEFAULT_LEVEL In this case the CameraManager.TorchCallback.onTorchStrengthLevelChanged will not be invoked.

If torch is enabled via setTorchMode after calling turnOnTorchWithStrengthLevel with level N then the flash unit will have the brightness level N. Since multiple applications are free to call setTorchMode, when the latest application that turned ON the torch mode exits, the torch mode will be turned OFF and in this case the brightness level will reset to default level.

unregisterAvailabilityCallback

fun unregisterAvailabilityCallback(callback: CameraManager.AvailabilityCallback): Unit

Remove a previously-added callback; the callback will no longer receive connection and disconnection callbacks.

Removing a callback that isn't registered has no effect.

unregisterTorchCallback

fun unregisterTorchCallback(callback: CameraManager.TorchCallback): Unit

Remove a previously-added callback; the callback will no longer receive torch mode status callbacks.

Removing a callback that isn't registered has no effect.