ImageCaptureScope

var captureMode: Int

Sets the capture mode for this use case.

var flashMode: Int

Sets the flash mode for this use case.

var ioExecutor: Executor

Sets the background executor for I/O tasks.

var isPostviewEnabled: Boolean

Sets whether postview is enabled for this use case.

var jpegQuality: Int

Sets the JPEG quality for this use case.

var outputFormat: Int

Sets the output format for this use case.

var postviewResolutionSelector: ResolutionSelector

Sets the resolution selector for postview images.

var resolutionSelector: ResolutionSelector

Sets the resolution selector for this use case.

var screenFlash: ImageCapture.ScreenFlash

Sets the ScreenFlash implementation for this use case.

var targetName: String

Sets the target name for this use case configuration.

var targetRotation: Int

Sets the target rotation for this use case.

inline fun ImageCaptureScope.camera2Interop(crossinline block: ImageCaptureCamera2Interop.() -> Unit): Unit

Applies Camera2 options inside an ImageCaptureScope DSL block.

Configures Camera2 options on the underlying ImageCapture.Builder within an imageCapture { ... } DSL block.

Options configured via ImageCaptureCamera2Interop include:

• Physical camera ID (ImageCaptureCamera2Interop.setPhysicalCameraId)

• Stream use case (ImageCaptureCamera2Interop.setStreamUseCase)

• Mirror mode (ImageCaptureCamera2Interop.setMirrorMode)

• Timestamp base (ImageCaptureCamera2Interop.setTimestampBase)

• Dynamic range profile (ImageCaptureCamera2Interop.setDynamicRangeProfile)

• Surface group ID (ImageCaptureCamera2Interop.setSurfaceGroupId)

• Still capture request key-value pairs (ImageCaptureCamera2Interop.setStillCaptureRequestOption)

• Still capture request template type (ImageCaptureCamera2Interop.setStillCaptureRequestTemplateType)

• Still capture callbacks (ImageCaptureCamera2Interop.setStillCaptureCallback)

Note: Using Camera2 interop options can override internal CameraX configurations. The capture request keys for one-shot still captures (such as androidx.camera.core.ImageCapture.takePicture) are determined by copying all repeating request keys (which may include keys added via androidx.camera.core.SessionConfig.Builder.setInterop or androidx.camera.core.CameraControl.applyInteropAsync) and then overriding them with the still capture request keys configured here. If an option configured via interop conflicts with options required by CameraX internally, the option from Camera2Interop will override, which may result in unexpected behavior.

Warning: Callbacks configured via interop receive raw android.hardware.camera2.CameraCaptureSession instances. Directly invoking state-altering methods on these raw objects (such as android.hardware.camera2.CameraCaptureSession.close or android.hardware.camera2.CameraCaptureSession.abortCaptures) bypasses CameraX pipeline management and may cause state desynchronization, stream interruption, or application crashes.

import androidx.camera.camera2.interop.camera2Interop
import androidx.camera.core.imageCapture

val imageCapture = imageCapture {
    camera2Interop {
        stillCaptureRequestTemplateType = CameraDevice.TEMPLATE_PREVIEW
        stillCaptureRequest[CaptureRequest.CONTROL_AF_MODE] = CaptureRequest.CONTROL_AF_MODE_OFF
        stillCaptureCallback =
            object : CameraCaptureSession.CaptureCallback() {
                override fun onCaptureCompleted(
                    session: CameraCaptureSession,
                    request: CaptureRequest,
                    result: TotalCaptureResult,
                ) {}
            }
        physicalCameraId = "5"
    }
}