CameraDevice

AUDIO_RESTRICTION_NONE

static val AUDIO_RESTRICTION_NONE: Int

No vibration or sound muting for this camera device. This is the default mode for all camera devices.

Value: 0

AUDIO_RESTRICTION_VIBRATION

static val AUDIO_RESTRICTION_VIBRATION: Int

Mute vibration from ringtones, alarms or notifications while this camera device is in use.

Value: 1

AUDIO_RESTRICTION_VIBRATION_SOUND

static val AUDIO_RESTRICTION_VIBRATION_SOUND: Int

Mute vibration and sound from ringtones, alarms or notifications while this camera device is in use.

Value: 3

TEMPLATE_MANUAL

static val TEMPLATE_MANUAL: Int

A basic template for direct application control of capture parameters. All automatic control is disabled (auto-exposure, auto-white balance, auto-focus), and post-processing parameters are set to preview quality. The manual capture parameters (exposure, sensitivity, and so on) are set to reasonable defaults, but should be overridden by the application depending on the intended use case. This template is guaranteed to be supported on camera devices that support the MANUAL_SENSOR capability.

Value: 6

TEMPLATE_PREVIEW

static val TEMPLATE_PREVIEW: Int

Create a request suitable for a camera preview window. Specifically, this means that high frame rate is given priority over the highest-quality post-processing. These requests would normally be used with the CameraCaptureSession#setRepeatingRequest method. This template is guaranteed to be supported on all camera devices.

Value: 1

TEMPLATE_RECORD

static val TEMPLATE_RECORD: Int

Create a request suitable for video recording. Specifically, this means that a stable frame rate is used, and post-processing is set for recording quality. These requests would commonly be used with the CameraCaptureSession#setRepeatingRequest method. This template is guaranteed to be supported on all camera devices except DEPTH_OUTPUT devices that are not BACKWARD_COMPATIBLE.

Value: 3

TEMPLATE_STILL_CAPTURE

static val TEMPLATE_STILL_CAPTURE: Int

Create a request suitable for still image capture. Specifically, this means prioritizing image quality over frame rate. These requests would commonly be used with the CameraCaptureSession#capture method. This template is guaranteed to be supported on all camera devices except DEPTH_OUTPUT devices that are not BACKWARD_COMPATIBLE.

Value: 2

TEMPLATE_VIDEO_SNAPSHOT

static val TEMPLATE_VIDEO_SNAPSHOT: Int

Create a request suitable for still image capture while recording video. Specifically, this means maximizing image quality without disrupting the ongoing recording. These requests would commonly be used with the CameraCaptureSession#capture method while a request based on TEMPLATE_RECORD is is in use with CameraCaptureSession#setRepeatingRequest. This template is guaranteed to be supported on all camera devices except legacy devices (CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL == LEGACY) and DEPTH_OUTPUT devices that are not BACKWARD_COMPATIBLE.

Value: 4

TEMPLATE_ZERO_SHUTTER_LAG

static val TEMPLATE_ZERO_SHUTTER_LAG: Int

Create a request suitable for zero shutter lag still capture. This means means maximizing image quality without compromising preview frame rate. AE/AWB/AF should be on auto mode. This is intended for application-operated ZSL. For device-operated ZSL, use CaptureRequest#CONTROL_ENABLE_ZSL if available. This template is guaranteed to be supported on camera devices that support the PRIVATE_REPROCESSING capability or the YUV_REPROCESSING capability.

Value: 5

close

abstract fun close(): Unit

Close the connection to this camera device as quickly as possible.

Immediately after this call, all calls to the camera device or active session interface will throw a IllegalStateException, except for calls to close(). Once the device has fully shut down, the StateCallback#onClosed callback will be called, and the camera is free to be re-opened.

Immediately after this call, besides the final StateCallback#onClosed calls, no further callbacks from the device or the active session will occur, and any remaining submitted capture requests will be discarded, as if CameraCaptureSession#abortCaptures had been called, except that no success or failure callbacks will be invoked.

createCaptureRequest

abstract fun createCaptureRequest(templateType: Int): CaptureRequest.Builder

Create a CaptureRequest.Builder for new capture requests, initialized with template for a target use case. The settings are chosen to be the best options for the specific camera device, so it is not recommended to reuse the same request for a different camera device; create a builder specific for that device and template and override the settings as desired, instead.

createCaptureRequest

open fun createCaptureRequest(
    templateType: Int, 
    physicalCameraIdSet: MutableSet<String!>!
): CaptureRequest.Builder

Create a CaptureRequest.Builder for new capture requests, initialized with template for a target use case. This methods allows clients to pass physical camera ids which can be used to customize the request for a specific physical camera. The settings are chosen to be the best options for the specific logical camera device. If additional physical camera ids are passed, then they will also use the same settings template. Clients can further modify individual camera settings by calling CaptureRequest.Builder#setPhysicalCameraKey.

Individual physical camera settings will only be honored for camera session that was initialized with corresponding physical camera id output configuration OutputConfiguration#setPhysicalCameraId and the same output targets are also attached in the request by CaptureRequest.Builder#addTarget.

The output is undefined for any logical camera streams in case valid physical camera settings are attached.

createCaptureSession

abstract fun createCaptureSession(
    outputs: MutableList<Surface!>, 
    callback: CameraCaptureSession.StateCallback, 
    handler: Handler?
): Unit

Deprecated: Please use createCaptureSession(android.hardware.camera2.params.SessionConfiguration) for the full set of configuration options available.

Create a new camera capture session by providing the target output set of Surfaces to the camera device.

createCaptureSession

open fun createCaptureSession(config: SessionConfiguration!): Unit

Create a new CameraCaptureSession using a SessionConfiguration helper object that aggregates all supported parameters.

The active capture session determines the set of potential output Surfaces for the camera device for each capture request. A given request may use all or only some of the outputs. Once the CameraCaptureSession is created, requests can be submitted with capture, captureBurst, setRepeatingRequest, or setRepeatingBurst.

Surfaces suitable for inclusion as a camera output can be created for various use cases and targets:

• For drawing to a SurfaceView: Once the SurfaceView's Surface is created, set the size of the Surface with android.view.SurfaceHolder#setFixedSize to be one of the sizes returned by getOutputSizes(SurfaceHolder.class) and then obtain the Surface by calling android.view.SurfaceHolder#getSurface. If the size is not set by the application, it will be rounded to the nearest supported size less than 1080p, by the camera device.
• For accessing through an OpenGL texture via a SurfaceTexture: Set the size of the SurfaceTexture with android.graphics.SurfaceTexture#setDefaultBufferSize to be one of the sizes returned by getOutputSizes(SurfaceTexture.class) before creating a Surface from the SurfaceTexture with Surface#Surface(SurfaceTexture). If the size is not set by the application, it will be set to be the smallest supported size less than 1080p, by the camera device.
• For recording with android.media.MediaCodec: Call android.media.MediaCodec#createInputSurface after configuring the media codec to use one of the sizes returned by getOutputSizes(MediaCodec.class)
• For recording with android.media.MediaRecorder: Call android.media.MediaRecorder#getSurface after configuring the media recorder to use one of the sizes returned by getOutputSizes(MediaRecorder.class), or configuring it to use one of the supported CamcorderProfiles.
• For access to RAW, uncompressed YUV, or compressed JPEG data in the application: Create an android.media.ImageReader object with one of the supported output formats given by StreamConfigurationMap#getOutputFormats(), setting its size to one of the corresponding supported sizes by passing the chosen output format into StreamConfigurationMap#getOutputSizes(int). Then obtain a android.view.Surface from it with android.media.ImageReader#getSurface(). If the ImageReader size is not set to a supported size, it will be rounded to a supported size less than 1080p by the camera device.

The camera device will query each Surface's size and formats upon this call, so they must be set to a valid setting at this time.

It can take several hundred milliseconds for the session's configuration to complete, since camera hardware may need to be powered on or reconfigured. Once the configuration is complete and the session is ready to actually capture data, the provided CameraCaptureSession.StateCallback's CameraCaptureSession.StateCallback#onConfigured callback will be called.

If a prior CameraCaptureSession already exists when this method is called, the previous session will no longer be able to accept new capture requests and will be closed. Any in-progress capture requests made on the prior session will be completed before it's closed. CameraCaptureSession.StateCallback#onConfigured for the new session may be invoked before CameraCaptureSession.StateCallback#onClosed is invoked for the prior session. Once the new session is configured, it is able to start capturing its own requests. To minimize the transition time, the CameraCaptureSession#abortCaptures call can be used to discard the remaining requests for the prior capture session before a new one is created. Note that once the new session is created, the old one can no longer have its captures aborted.

Using larger resolution outputs, or more outputs, can result in slower output rate from the device.

Configuring a session with an empty or null list will close the current session, if any. This can be used to release the current session's target surfaces for another use.

This function throws an IllegalArgumentException if called with a SessionConfiguration lacking state callbacks or valid output surfaces. The only exceptions are deferred SurfaceView or SurfaceTexture outputs. See android.hardware.camera2.params.OutputConfiguration#OutputConfiguration(android.util.Size,java.lang.Class) for details.

Regular capture

While any of the sizes from android.hardware.camera2.params.StreamConfigurationMap#getOutputSizes can be used when a single output stream is configured, a given camera device may not be able to support all combination of sizes, formats, and targets when multiple outputs are configured at once. The tables below list the maximum guaranteed resolutions for combinations of streams and targets, given the capabilities of the camera device. These are valid for when the input configuration is not set and therefore no reprocessing is active.

If an application tries to create a session using a set of targets that exceed the limits described in the below tables, one of three possibilities may occur. First, the session may be successfully created and work normally. Second, the session may be successfully created, but the camera device won't meet the frame rate guarantees as described in android.hardware.camera2.params.StreamConfigurationMap#getOutputMinFrameDuration. Or third, if the output set cannot be used at all, session creation will fail entirely, with CameraCaptureSession.StateCallback#onConfigureFailed being invoked.

For the type column, PRIV refers to any target whose available sizes are found using StreamConfigurationMap#getOutputSizes(Class) with no direct application-visible format, YUV refers to a target Surface using the android.graphics.ImageFormat#YUV_420_888 format, JPEG refers to the android.graphics.ImageFormat#JPEG format, and RAW refers to the android.graphics.ImageFormat#RAW_SENSOR format.

For the maximum size column, PREVIEW refers to the best size match to the device's screen resolution, or to 1080p (1920x1080), whichever is smaller. RECORD refers to the camera device's maximum supported recording resolution, as determined by android.media.CamcorderProfile. And MAXIMUM refers to the camera device's maximum output resolution for that format or target from android.hardware.camera2.params.StreamConfigurationMap#getOutputSizes.

To use these tables, determine the number and the formats/targets of outputs needed, and find the row(s) of the table with those targets. The sizes indicate the maximum set of sizes that can be used; it is guaranteed that for those targets, the listed sizes and anything smaller from the list given by android.hardware.camera2.params.StreamConfigurationMap#getOutputSizes can be successfully used to create a session. For example, if a row indicates that a 8 megapixel (MP) YUV_420_888 output can be used together with a 2 MP PRIV output, then a session can be created with targets [8 MP YUV, 2 MP PRIV] or targets [2 MP YUV, 2 MP PRIV]; but a session with targets [8 MP YUV, 4 MP PRIV], targets [4 MP YUV, 4 MP PRIV], or targets [8 MP PRIV, 2 MP YUV] would not be guaranteed to work, unless some other row of the table lists such a combination.

LEGACY-level guaranteed configurations

Legacy devices (CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL == LEGACY) support at least the following stream combinations:

LIMITED-level additional guaranteed configurations

Limited-level (CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL == LIMITED) devices support at least the following stream combinations in addition to those for LEGACY devices:

FULL-level additional guaranteed configurations

FULL-level (CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL == FULL) devices support at least the following stream combinations in addition to those for LIMITED devices:

RAW-capability additional guaranteed configurations

RAW-capability (CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES includes RAW) devices additionally support at least the following stream combinations on both FULL and LIMITED devices:

BURST-capability additional guaranteed configurations

BURST-capability (CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES includes BURST_CAPTURE) devices support at least the below stream combinations in addition to those for LIMITED devices. Note that all FULL-level devices support the BURST capability, and the below list is a strict subset of the list for FULL-level devices, so this table is only relevant for LIMITED-level devices that support the BURST_CAPTURE capability.

LEVEL-3 additional guaranteed configurations

LEVEL-3 (CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL == LEVEL_3) support at least the following stream combinations in addition to the combinations for FULL and for RAW capability (CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES includes RAW):

Concurrent stream guaranteed configurations

BACKWARD_COMPATIBLE devices capable of streaming concurrently with other devices as described by android.hardware.camera2.CameraManager#getConcurrentCameraIds have the following guaranteed streams (when streaming concurrently with other devices)

Note: The sizes mentioned for these concurrent streams are the maximum sizes guaranteed to be supported. Sizes smaller than these, obtained by android.hardware.camera2.params.StreamConfigurationMap#getOutputSizes for a particular format, are supported as well.

Devices which are not backwards-compatible, support a mandatory single stream of size sVGA with image format DEPTH16 during concurrent operation.

For guaranteed concurrent stream configurations:

sVGA refers to the camera device's maximum resolution for that format from android.hardware.camera2.params.StreamConfigurationMap#getOutputSizes or VGA resolution (640X480) whichever is lower.

s720p refers to the camera device's maximum resolution for that format from android.hardware.camera2.params.StreamConfigurationMap#getOutputSizes or 720p(1280X720) whichever is lower.

s1440p refers to the camera device's maximum resolution for that format from android.hardware.camera2.params.StreamConfigurationMap#getOutputSizes or 1440p(1920X1440) whichever is lower.

MONOCHROME-capability (CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES includes MONOCHROME) devices supporting Y8 support substituting YUV streams with Y8 in all guaranteed stream combinations for the device's hardware level and capabilities.

Clients can access the above mandatory stream combination tables via android.hardware.camera2.params.MandatoryStreamCombination.

Devices capable of outputting HEIC formats (StreamConfigurationMap#getOutputFormats contains android.graphics.ImageFormat#HEIC) will support substituting JPEG streams with HEIC in all guaranteed stream combinations for the device's hardware level and capabilities. Calling createCaptureSession with both JPEG and HEIC outputs is not supported.

LEGACY-level additional guaranteed combinations with multi-resolution outputs

Devices capable of multi-resolution output for a particular format ( android.hardware.camera2.params.MultiResolutionStreamConfigurationMap#getOutputInfo returns a non-empty list) support using MultiResolutionImageReader for MAXIMUM resolution streams of that format for all mandatory stream combinations. For example, if a LIMITED camera device supports multi-resolution output streams for both JPEG and PRIVATE, in addition to the stream configurations in the LIMITED and Legacy table above, the camera device supports the following guaranteed stream combinations (MULTI_RES in the Max size column refers to a MultiResolutionImageReader created based on the variable max resolutions supported):

LIMITED-level additional guaranteed configurations with multi-resolution outputs

Additional guaranteed combinations for ULTRA_HIGH_RESOLUTION sensors

Devices with the ULTRA_HIGH_RESOLUTION_SENSOR capability have some additional guarantees which clients can take advantage of:

Here, SC Map, refers to the StreamConfigurationMap, the target stream sizes must be chosen from. DEFAULT refers to the default sensor pixel mode StreamConfigurationMap and MAX_RES refers to the maximum resolution StreamConfigurationMap. For MAX_RES streams, MAX in the Max size column refers to the maximum size from android.hardware.camera2.params.StreamConfigurationMap#getOutputSizes and StreamConfigurationMap#getHighResolutionOutputSizes. Note: The same capture request must not mix targets from StreamConfigurationMaps corresponding to different sensor pixel modes.

10-bit output additional guaranteed configurations

10-bit output capable CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_DYNAMIC_RANGE_TEN_BIT devices support at least the following stream combinations:

Here PRIV can be either 8 or 10-bit android.graphics.ImageFormat#PRIVATE pixel format. YUV can be either android.graphics.ImageFormat#YUV_420_888 or android.graphics.ImageFormat#YCBCR_P010. For the maximum size column, PREVIEW refers to the best size match to the device's screen resolution, or to 1080p (1920x1080), whichever is smaller. RECORD refers to the camera device's maximum supported recording resolution, as determined by android.media.CamcorderProfile. MAXIMUM refers to the camera device's maximum output resolution for that format or target from StreamConfigurationMap#getOutputSizes(int). Do note that invalid combinations such as having a camera surface configured to use pixel format android.graphics.ImageFormat#YUV_420_888 with a 10-bit profile will cause a capture session initialization failure.

android.graphics.ImageFormat#JPEG_R may also be supported if advertised by android.hardware.camera2.params.StreamConfigurationMap. When initializing a capture session that includes a Jpeg/R camera output clients must consider the following items w.r.t. the 10-bit mandatory stream combination table:

• To generate the compressed Jpeg/R image a single android.graphics.ImageFormat#YCBCR_P010 output will be used internally by the camera device.
• On camera devices that are able to support concurrent 10 and 8-bit capture requests see android.hardware.camera2.params.DynamicRangeProfiles#getProfileCaptureRequestConstraints an extra android.graphics.ImageFormat#JPEG will also be configured internally to help speed up the encoding process.

STREAM_USE_CASE capability additional guaranteed configurations

Devices with the STREAM_USE_CASE capability (android.hardware.camera2.CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES includes android.hardware.camera2.CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES_STREAM_USE_CASE) support below additional stream combinations:

STREAM_USE_CASE_CROPPED_RAW capability additional guaranteed configurations

Devices that include the CameraMetadata#SCALER_AVAILABLE_STREAM_USE_CASES_CROPPED_RAW stream use-case in CameraCharacteristics#SCALER_AVAILABLE_STREAM_USE_CASES, support the additional stream combinations below:

Preview stabilization guaranteed stream configurations

For devices where CameraCharacteristics#CONTROL_AVAILABLE_VIDEO_STABILIZATION_MODES includes CameraMetadata#CONTROL_VIDEO_STABILIZATION_MODE_PREVIEW_STABILIZATION, the following stream combinations are guaranteed, for CaptureRequests where CaptureRequest#CONTROL_VIDEO_STABILIZATION_MODE is set to CameraMetadata#CONTROL_VIDEO_STABILIZATION_MODE_PREVIEW_STABILIZATION

For the maximum size column, PREVIEW refers to the best size match to the device's screen resolution, or to 1080p (1920x1080), whichever is smaller. RECORD refers to the camera device's maximum supported recording resolution, as determined by android.media.CamcorderProfile. MAXIMUM refers to the camera device's maximum output resolution for that format or target from StreamConfigurationMap#getOutputSizes(int).

Since the capabilities of camera devices vary greatly, a given camera device may support target combinations with sizes outside of these guarantees, but this can only be tested for by calling isSessionConfigurationSupported or attempting to create a session with such targets.

Exception on 176x144 (QCIF) resolution: Camera devices usually have a fixed capability for downscaling from larger resolution to smaller, and the QCIF resolution sometimes is not fully supported due to this limitation on devices with high-resolution image sensors. Therefore, trying to configure a QCIF resolution stream together with any other stream larger than 1920x1080 resolution (either width or height) might not be supported, and capture session creation will fail if it is not.

Reprocessing

If a camera device supports YUV reprocessing (CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES_YUV_REPROCESSING) or PRIVATE reprocessing (CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES_PRIVATE_REPROCESSING), the application can also create a reprocessable capture session to submit reprocess capture requests in addition to regular capture requests, by setting an input configuration for the session. A reprocess capture request takes the next available buffer from the session's input Surface, and sends it through the camera device's processing pipeline again, to produce buffers for the request's target output Surfaces. No new image data is captured for a reprocess request. However the input buffer provided by the application must be captured previously by the same camera device in the same session directly (e.g. for Zero-Shutter-Lag use case) or indirectly (e.g. combining multiple output images).

The active reprocessable capture session determines an input Surface and the set of potential output Surfaces for the camera devices for each capture request. The application can use #createCaptureRequest to create regular capture requests to capture new images from the camera device, and use createReprocessCaptureRequest to create reprocess capture requests to process buffers from the input Surface. Some combinations of output Surfaces in a session may not be used in a request simultaneously. The guaranteed combinations of output Surfaces that can be used in a request simultaneously are listed in the tables under #createCaptureSession. All the output Surfaces in one capture request will come from the same source, either from a new capture by the camera device, or from the input Surface depending on if the request is a reprocess capture request.

Input formats and sizes supported by the camera device can be queried via StreamConfigurationMap#getInputFormats and StreamConfigurationMap#getInputSizes. For each supported input format, the camera device supports a set of output formats and sizes for reprocessing that can be queried via StreamConfigurationMap#getValidOutputFormatsForInput and android.hardware.camera2.params.StreamConfigurationMap#getOutputSizes. While output Surfaces with formats that aren't valid reprocess output targets for the input configuration can be part of a session, they cannot be used as targets for a reprocessing request.

Since the application cannot access android.graphics.ImageFormat#PRIVATE images directly, an output Surface created by android.media.ImageReader#newInstance with android.graphics.ImageFormat#PRIVATE as the format will be considered as intended to be used for reprocessing input and thus the android.media.ImageReader size must match one of the supported input sizes for android.graphics.ImageFormat#PRIVATE format. Otherwise, creating a reprocessable capture session will fail.

Starting from API level 30, recreating a reprocessable capture session will flush all the queued but not yet processed buffers from the input surface.

The configurations in the tables below are guaranteed for creating a reprocessable capture session if the camera device supports YUV reprocessing or PRIVATE reprocessing. However, not all output targets used to create a reprocessable session may be used in a CaptureRequest simultaneously. For devices that support only 1 output target in a reprocess CaptureRequest, submitting a reprocess CaptureRequest with multiple output targets will result in a CaptureFailure. For devices that support multiple output targets in a reprocess CaptureRequest, the guaranteed output targets that can be included in a CaptureRequest simultaneously are listed in the tables under #createCaptureSession. For example, with a FULL-capability (CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL == FULL) device that supports PRIVATE reprocessing, an application can create a reprocessable capture session with 1 input, (PRIV, MAXIMUM), and 3 outputs, (PRIV, MAXIMUM), (PRIV, PREVIEW), and (YUV, MAXIMUM). However, it's not guaranteed that an application can submit a regular or reprocess capture with (PRIV, MAXIMUM) and (YUV, MAXIMUM) outputs based on the table listed under #createCaptureSession. In other words, use the tables below to determine the guaranteed stream configurations for creating a reprocessable capture session, and use the tables under #createCaptureSession to determine the guaranteed output targets that can be submitted in a regular or reprocess CaptureRequest simultaneously.

Reprocessing with 10-bit output targets on 10-bit capable CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES_DYNAMIC_RANGE_TEN_BIT devices is not supported. Trying to initialize a repreocessable capture session with one ore more output configurations set OutputConfiguration#setDynamicRangeProfile to use a 10-bit dynamic range profile android.hardware.camera2.params.DynamicRangeProfiles will trigger IllegalArgumentException.

LIMITED-level (CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL == LIMITED) devices support at least the following stream combinations for creating a reprocessable capture session in addition to those listed earlier for regular captures for LIMITED devices:

FULL-level (CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL == FULL) devices support at least the following stream combinations for creating a reprocessable capture session in addition to those for LIMITED devices:

RAW-capability (CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES includes RAW) devices additionally support at least the following stream combinations for creating a reprocessable capture session on both FULL and LIMITED devices

LEVEL-3 (CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL == LEVEL_3) devices support at least the following stream combinations for creating a reprocessable capture session in addition to those for FULL devices. Note that while the second configuration allows for configuring MAXIMUM YUV and JPEG outputs at the same time, that configuration is not listed for regular capture sessions, and therefore simultaneous output to both targets is not allowed.

If a camera device supports multi-resolution YUV input and multi-resolution YUV output or supports multi-resolution PRIVATE input and multi-resolution PRIVATE output, the additional mandatory stream combinations for LIMITED and FULL devices are listed below (MULTI_RES in the Max size column refers to a MultiResolutionImageReader for output, and a multi-resolution InputConfiguration for input):

Devices with the ULTRA_HIGH_RESOLUTION_SENSOR capability have some additional guarantees which clients can take advantage of :

Constrained high-speed recording

The application can use a normal capture session for high speed capture if the desired high speed FPS ranges are advertised by CameraCharacteristics#CONTROL_AE_AVAILABLE_TARGET_FPS_RANGES, in which case all API semantics associated with normal capture sessions applies.

A high-speed capture session can be use for high speed video recording (>=120fps) when the camera device supports high speed video capability (i.e., CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES contains CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_CONSTRAINED_HIGH_SPEED_VIDEO). A constrained high-speed capture session has special limitations compared with a normal capture session:

• In addition to the output target Surface requirements specified above for regular captures, a high speed capture session will only support up to 2 output Surfaces, though the application might choose to configure just one Surface (e.g., preview only). All Surfaces must be either video encoder surfaces (acquired by android.media.MediaRecorder#getSurface or android.media.MediaCodec#createInputSurface) or preview surfaces (obtained from android.view.SurfaceView, android.graphics.SurfaceTexture via android.view.Surface#Surface(android.graphics.SurfaceTexture)). The Surface sizes must be one of the sizes reported by StreamConfigurationMap#getHighSpeedVideoSizes. When multiple Surfaces are configured, their size must be same.
• An active high speed capture session only accepts request lists created via CameraConstrainedHighSpeedCaptureSession#createHighSpeedRequestList, and the request list can only be submitted to this session via captureBurst, or setRepeatingBurst.
• The FPS ranges being requested to this session must be selected from StreamConfigurationMap#getHighSpeedVideoFpsRangesFor. The application can still use CaptureRequest#CONTROL_AE_TARGET_FPS_RANGE to control the desired FPS range. Switching to an FPS range that has different maximum FPS may trigger some camera device reconfigurations, which may introduce extra latency. It is recommended that the application avoids unnecessary maximum target FPS changes as much as possible during high speed streaming.
• For the request lists submitted to this session, the camera device will override the control mode, auto-exposure (AE), auto-white balance (AWB) and auto-focus (AF) to CameraMetadata#CONTROL_MODE_AUTO, CameraMetadata#CONTROL_AE_MODE_ON, CameraMetadata#CONTROL_AWB_MODE_AUTO and CameraMetadata#CONTROL_AF_MODE_CONTINUOUS_VIDEO, respectively. All post-processing block mode controls will be overridden to be FAST. Therefore, no manual control of capture and post-processing parameters is possible. Beside these, only a subset of controls will work, see CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_CONSTRAINED_HIGH_SPEED_VIDEO for more details.

createCaptureSessionByOutputConfigurations

abstract fun createCaptureSessionByOutputConfigurations(
    outputConfigurations: MutableList<OutputConfiguration!>!, 
    callback: CameraCaptureSession.StateCallback!, 
    handler: Handler?
): Unit

Deprecated: Please use createCaptureSession(android.hardware.camera2.params.SessionConfiguration) for the full set of configuration options available.

Create a new camera capture session by providing the target output set of Surfaces and its corresponding surface configuration to the camera device.

createConstrainedHighSpeedCaptureSession

abstract fun createConstrainedHighSpeedCaptureSession(
    outputs: MutableList<Surface!>, 
    callback: CameraCaptureSession.StateCallback, 
    handler: Handler?
): Unit

Deprecated: Please use createCaptureSession(android.hardware.camera2.params.SessionConfiguration) for the full set of configuration options available.

Create a new constrained high speed capture session.

createExtensionSession

open fun createExtensionSession(extensionConfiguration: ExtensionSessionConfiguration): Unit

Initialize a specific device-specific extension augmented camera capture session.

Extension sessions can be used to enable device-specific operation modes like CameraExtensionCharacteristics#EXTENSION_NIGHT or CameraExtensionCharacteristics#EXTENSION_HDR. These modes are less flexible than the full camera API, but enable access to more sophisticated processing algorithms that can capture multi-frame bursts to generate single output images. To query for available extensions on this device call CameraExtensionCharacteristics#getSupportedExtensions().

This method will also trigger the setup of the internal processing pipeline for extension augmented preview and multi-frame still capture.

If a prior CameraCaptureSession already exists when this method is called, the previous session will no longer be able to accept new capture requests and will be closed. Any in-progress capture requests made on the prior session will be completed before it's closed.

The CameraExtensionSession will be active until the client either calls CameraExtensionSession.close() or creates a new camera capture session. In both cases all internal resources will be released, continuous repeating requests stopped and any pending multi-frame capture requests flushed.

Note that the CameraExtensionSession currently supports at most wo multi frame capture surface formats: ImageFormat.JPEG will be supported by all extensions and ImageFormat.YUV_420_888 may or may not be supported. Clients must query the multi-frame capture format support using CameraExtensionCharacteristics#getExtensionSupportedSizes(int, int). For repeating requests CameraExtensionSession supports only android.graphics.SurfaceTexture as output. Clients can query the supported resolution for the repeating request output using getExtensionSupportedSizes(..., Class).

At the very minimum the initialization expects either one valid output surface for repeating or one valid output for high-quality single requests registered in the outputs argument of the extension configuration argument. At the maximum the initialization will accept two valid output surfaces, one for repeating and the other for single requests. Additional unsupported surfaces passed to ExtensionSessionConfiguration will cause an IllegalArgumentException to be thrown.

createReprocessCaptureRequest

abstract fun createReprocessCaptureRequest(inputResult: TotalCaptureResult): CaptureRequest.Builder

Create a CaptureRequest.Builder for a new reprocess CaptureRequest from a TotalCaptureResult.

Each reprocess CaptureRequest processes one buffer from CameraCaptureSession's input Surface to all output Surfaces included in the reprocess capture request. The reprocess input images must be generated from one or multiple output images captured from the same camera device. The application can provide input images to camera device via android.media.ImageWriter#queueInputImage. The application must use the capture result of one of those output images to create a reprocess capture request so that the camera device can use the information to achieve optimal reprocess image quality. For camera devices that support only 1 output Surface, submitting a reprocess CaptureRequest with multiple output targets will result in a CaptureFailure. From Android 14 onward, CaptureRequest#CONTROL_CAPTURE_INTENT will be set to CameraMetadata#CONTROL_CAPTURE_INTENT_STILL_CAPTURE by default. Prior to Android 14, apps will need to explicitly set this key themselves.

createReprocessableCaptureSession

abstract fun createReprocessableCaptureSession(
    inputConfig: InputConfiguration, 
    outputs: MutableList<Surface!>, 
    callback: CameraCaptureSession.StateCallback, 
    handler: Handler?
): Unit

Deprecated: Please use createCaptureSession(android.hardware.camera2.params.SessionConfiguration) for the full set of configuration options available.

Create a new reprocessable camera capture session by providing the desired reprocessing input Surface configuration and the target output set of Surfaces to the camera device.

createReprocessableCaptureSessionByConfigurations

abstract fun createReprocessableCaptureSessionByConfigurations(
    inputConfig: InputConfiguration, 
    outputs: MutableList<OutputConfiguration!>, 
    callback: CameraCaptureSession.StateCallback, 
    handler: Handler?
): Unit

Deprecated: Please use createCaptureSession(android.hardware.camera2.params.SessionConfiguration) for the full set of configuration options available.

Create a new reprocessable camera capture session by providing the desired reprocessing input configuration and output OutputConfiguration to the camera device.

getCameraAudioRestriction

open fun getCameraAudioRestriction(): Int

Get currently applied global camera audio restriction mode.

Application can use this method to retrieve the system-wide camera audio restriction settings described in setCameraAudioRestriction.

getId

abstract fun getId(): String

Get the ID of this camera device.

This matches the ID given to android.hardware.camera2.CameraManager#openCamera to instantiate this this camera device.

This ID can be used to query the camera device's fixed properties with android.hardware.camera2.CameraManager#getCameraCharacteristics.

This method can be called even if the device has been closed or has encountered a serious error.

isSessionConfigurationSupported

open fun isSessionConfigurationSupported(sessionConfig: SessionConfiguration): Boolean

Checks whether a particular SessionConfiguration is supported by the camera device.

This method performs a runtime check of a given SessionConfiguration. The result confirms whether or not the passed session configuration can be successfully used to create a camera capture session using CameraDevice#createCaptureSession(.

The method can be called at any point before, during and after active capture session. It must 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 stream combinations. The available mandatory stream combinations android.hardware.camera2.params.MandatoryStreamCombination are better suited for this purpose.

NOTE: For apps targeting android.os.Build.VERSION_CODES#VANILLA_ICE_CREAM and above, this method will automatically delegate to CameraDeviceSetup#isSessionConfigurationSupported whenever possible. This means that the output of this method will consider parameters set through SessionConfiguration#setSessionParameters as well.

Session Parameters will be ignored for apps targeting <= android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE, or if CameraManager#isCameraDeviceSetupSupported returns false for the camera id associated with this CameraDevice.

setCameraAudioRestriction

open fun setCameraAudioRestriction(mode: Int): Unit

Set audio restriction mode when this CameraDevice is being used.

Some camera hardware (e.g. devices with optical image stabilization support) are sensitive to device vibration and video recordings can be ruined by unexpected sounds. Applications can use this method to suppress vibration or sounds coming from ringtones, alarms or notifications. Other vibration or sounds (e.g. media playback or accessibility) will not be muted.

The mute mode is a system-wide setting. When multiple CameraDevice objects are setting different modes, the system will pick a the mode that's union of all modes set by CameraDevice. Applications can also use getCameraAudioRestriction to query current system-wide camera mute mode in effect.

The mute settings from this CameraDevice will be automatically removed when the CameraDevice is closed or the application is disconnected from the camera.