androidx.camera.camera2.interop

suspend inline fun CameraControl.applyCamera2Interop(crossinline block: CameraControlCamera2Interop.() -> Unit): Unit

Applies Camera2 options to a CameraControl asynchronously within a coroutine.

Dynamically updates repeating capture request parameters or capture request keys on an active camera session. Options configured within a single block are applied atomically in a single repeating capture request update. Subsequent calls to applyCamera2Interop update parameters incrementally without clearing previously set keys, unless explicitly cleared using CameraControlCamera2Interop.clearCaptureRequestOption or CameraControlCamera2Interop.clearAllCaptureRequestOptions. This overwrites options set with SessionConfigCamera2Interop via androidx.camera.core.SessionConfig.Builder.setInterop (or SessionConfig.Builder.camera2Interop).

This function suspends until all specified interoperability options have been successfully updated in the underlying repeating capture request. Throws CameraControl.OperationCanceledException if a newer configuration is applied before this operation takes effect or if the camera is closed.

Options configured via CameraControlCamera2Interop include:

• Capture request key-value pairs (CameraControlCamera2Interop.setCaptureRequestOption)

• Clearing specific capture request keys (CameraControlCamera2Interop.clearCaptureRequestOption)

• Clearing all capture request keys (CameraControlCamera2Interop.clearAllCaptureRequestOptions)

• Capture request template type (CameraControlCamera2Interop.setRepeatingCaptureRequestTemplate or CameraControlCamera2Interop.repeatingCaptureRequestTemplate)

• Repeating capture callbacks (CameraControlCamera2Interop.setRepeatingCaptureCallback or CameraControlCamera2Interop.repeatingCaptureCallback)

Note: Using Camera2 interop options can override internal CameraX configurations. 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 or interfere with 3A routines and camera control APIs.

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.applyCamera2Interop

cameraControl.applyCamera2Interop {
    captureRequest[CaptureRequest.CONTROL_AE_MODE] = CaptureRequest.CONTROL_AE_MODE_OFF
    repeatingCaptureCallback = object : CameraCaptureSession.CaptureCallback() {}
}

inline fun CameraControl.applyCamera2InteropAsync(crossinline block: CameraControlCamera2Interop.() -> Unit): ListenableFuture<Void>

Applies Camera2 options to a CameraControl asynchronously.

Dynamically updates repeating capture request parameters or capture request keys on an active camera session. Options configured within a single block are applied atomically in a single repeating capture request update. Subsequent calls to applyCamera2InteropAsync update parameters incrementally without clearing previously set keys, unless explicitly cleared using CameraControlCamera2Interop.clearCaptureRequestOption or CameraControlCamera2Interop.clearAllCaptureRequestOptions. This overwrites options set with SessionConfigCamera2Interop via androidx.camera.core.SessionConfig.Builder.setInterop (or SessionConfig.Builder.camera2Interop).

Options configured via CameraControlCamera2Interop include:

• Capture request key-value pairs (CameraControlCamera2Interop.setCaptureRequestOption)

• Clearing specific capture request keys (CameraControlCamera2Interop.clearCaptureRequestOption)

• Clearing all capture request keys (CameraControlCamera2Interop.clearAllCaptureRequestOptions)

• Capture request template type (CameraControlCamera2Interop.setRepeatingCaptureRequestTemplate or CameraControlCamera2Interop.repeatingCaptureRequestTemplate)

• Repeating capture callbacks (CameraControlCamera2Interop.setRepeatingCaptureCallback or CameraControlCamera2Interop.repeatingCaptureCallback)

Note: Using Camera2 interop options can override internal CameraX configurations. 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 or interfere with 3A routines and camera control APIs.

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.applyCamera2Interop
import androidx.camera.camera2.interop.applyCamera2InteropAsync

cameraControl.applyCamera2InteropAsync {
    captureRequest[CaptureRequest.CONTROL_AE_MODE] = CaptureRequest.CONTROL_AE_MODE_OFF
    repeatingCaptureCallback = object : CameraCaptureSession.CaptureCallback() {}
}

inline fun <B : UseCase.InteropConfigurable<B>> B.camera2Interop(
    crossinline block: UseCaseCamera2Interop.() -> Unit
): B

Applies Camera2 options to a UseCase builder.

Configures Camera2 options on builders implementing UseCase.InteropConfigurable (such as androidx.camera.core.Preview.Builder, androidx.camera.core.ImageAnalysis.Builder, or androidx.camera.video.VideoCapture.Builder). For ImageCapture.Builder, use the dedicated ImageCapture.Builder.camera2Interop extension function.

Options configured via UseCaseCamera2Interop include:

• Physical camera ID (UseCaseCamera2Interop.setPhysicalCameraId)

• Stream use case (UseCaseCamera2Interop.setStreamUseCase)

• Mirror mode (UseCaseCamera2Interop.setMirrorMode)

• Timestamp base (UseCaseCamera2Interop.setTimestampBase)

• Dynamic range profile (UseCaseCamera2Interop.setDynamicRangeProfile)

• Surface group ID (UseCaseCamera2Interop.setSurfaceGroupId)

Note: Using Camera2 interop options can override internal CameraX configurations. 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.

import androidx.camera.camera2.interop.camera2Interop
import androidx.camera.core.Preview
import androidx.camera.core.preview

val preview =
    Preview.Builder()
        .camera2Interop {
            physicalCameraId = "5"
            mirrorMode = OutputConfiguration.MIRROR_MODE_H
        }
        .build()

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

Applies Camera2 options to an ImageCapture.Builder.

Configures Camera2 options specific to ImageCapture.Builder.

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
import androidx.camera.core.imageCapture

val imageCapture =
    ImageCapture.Builder()
        .camera2Interop {
            stillCaptureRequestTemplateType = CameraDevice.TEMPLATE_STILL_CAPTURE
            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"
        }
        .build()

inline fun <B : UseCase.InteropConfigurable<B>> InteropConfigurableScope<B>.camera2Interop(
    crossinline block: UseCaseCamera2Interop.() -> Unit
): Unit

Applies Camera2 options inside an InteropConfigurableScope DSL block.

Configures Camera2 options on the underlying UseCase builder within Kotlin DSL blocks such as preview { ... }, imageAnalysis { ... }, or videoCapture { ... }. For imageCapture { ... }, use the dedicated ImageCaptureScope.camera2Interop extension function.

Options configured via UseCaseCamera2Interop include:

• Physical camera ID (UseCaseCamera2Interop.setPhysicalCameraId)

• Stream use case (UseCaseCamera2Interop.setStreamUseCase)

• Mirror mode (UseCaseCamera2Interop.setMirrorMode)

• Timestamp base (UseCaseCamera2Interop.setTimestampBase)

• Dynamic range profile (UseCaseCamera2Interop.setDynamicRangeProfile)

• Surface group ID (UseCaseCamera2Interop.setSurfaceGroupId)

Note: Using Camera2 interop options can override internal CameraX configurations. 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.

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

val preview = preview {
    camera2Interop {
        physicalCameraId = "0"
        mirrorMode = OutputConfiguration.MIRROR_MODE_H
    }
}

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"
    }
}

inline fun SessionConfig.Builder.camera2Interop(crossinline block: SessionConfigCamera2Interop.() -> Unit): SessionConfig.Builder

Applies Camera2 options to a SessionConfig.Builder.

Configures Camera2 options for a capture session builder. Can be called on a SessionConfig.Builder directly or within a androidx.camera.core.sessionConfig DSL block.

Options configured via SessionConfigCamera2Interop include:

• Session parameters (SessionConfigCamera2Interop.setSessionParameter)

• Session type (SessionConfigCamera2Interop.setSessionType)

• Color space (SessionConfigCamera2Interop.setColorSpace)

• Session state callbacks (SessionConfigCamera2Interop.setSessionStateCallback)

• Device state callbacks (SessionConfigCamera2Interop.setDeviceStateCallback)

• Capture request key-value pairs (SessionConfigCamera2Interop.setCaptureRequestOption)

• Clearing specific capture request keys (SessionConfigCamera2Interop.clearCaptureRequestOption)

• Clearing all capture request keys (SessionConfigCamera2Interop.clearAllCaptureRequestOptions)

• Capture request template type (SessionConfigCamera2Interop.setRepeatingCaptureRequestTemplate)

• Repeating capture callbacks (SessionConfigCamera2Interop.setRepeatingCaptureCallback)

Note: Using Camera2 interop options can override internal CameraX configurations. 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.CameraDevice and android.hardware.camera2.CameraCaptureSession instances. Directly invoking state-altering methods on these raw objects (such as android.hardware.camera2.CameraCaptureSession.close, android.hardware.camera2.CameraCaptureSession.abortCaptures, or android.hardware.camera2.CameraDevice.close) bypasses CameraX pipeline management and may cause state desynchronization, stream interruption, or application crashes.

import androidx.camera.camera2.interop.camera2Interop
import androidx.camera.core.SessionConfig
import androidx.camera.core.preview
import androidx.camera.core.sessionConfig

val sessionConfig =
    SessionConfig.Builder(preview)
        .camera2Interop {
            colorSpace = ColorSpace.Named.DISPLAY_P3.ordinal
            sessionParameter[CaptureRequest.CONTROL_AE_TARGET_FPS_RANGE] = Range(60, 60)
            captureRequest[CaptureRequest.CONTROL_AE_TARGET_FPS_RANGE] = Range(60, 60)
            repeatingCaptureRequestTemplate = CameraDevice.TEMPLATE_PREVIEW
            repeatingCaptureCallback = object : CameraCaptureSession.CaptureCallback() {}
        }
        .build()

import androidx.camera.camera2.interop.camera2Interop
import androidx.camera.core.preview
import androidx.camera.core.sessionConfig

val sessionConfig =
    sessionConfig(listOf(preview)) {
        camera2Interop {
            colorSpace = ColorSpace.Named.DISPLAY_P3.ordinal
            sessionParameter[CaptureRequest.CONTROL_AE_TARGET_FPS_RANGE] = Range(60, 60)
            captureRequest[CaptureRequest.CONTROL_AE_TARGET_FPS_RANGE] = Range(60, 60)
            repeatingCaptureRequestTemplate = CameraDevice.TEMPLATE_PREVIEW
            repeatingCaptureCallback = object : CameraCaptureSession.CaptureCallback() {}
        }
    }

fun String.toCameraSelector(): CameraSelector

Creates a CameraSelector targeting this camera ID string.

val CameraInfo.cameraCharacteristics: CameraCharacteristics

Returns the CameraCharacteristics from this CameraInfo.

val CameraInfo.cameraId: String

Returns the Camera2 camera ID from this CameraInfo.