CameraCaptureSessionInterop

Artifact: androidx.camera:camera-camera2

View Source

Added in 1.7.0-rc01

---

Kotlin |Java

interface CameraCaptureSessionInterop

Known direct subclasses

CameraControlCamera2Interop, SessionConfigCamera2Interop

CameraControlCamera2Interop	Configures Camera2 options on a androidx.camera.core.CameraControl.
SessionConfigCamera2Interop	Configures Camera2 options on a androidx.camera.core.SessionConfig.

---

Configures Camera2 android.hardware.camera2.CameraCaptureSession options.

Summary

Public functions
Unit	clearAllCaptureRequestOptions() Clears all CaptureRequest.Keys previously set on this target.
Unit	clearCaptureRequestOption(key: CaptureRequest.Key<*>) Clears a CaptureRequest.Key previously set on this target.
Unit	<V : Any?> setCaptureRequestOption(key: CaptureRequest.Key<V>, value: V) Sets a CaptureRequest.Key and value on repeating and one-shot requests.
Unit	setRepeatingCaptureCallback(     executor: Executor,     callback: CameraCaptureSession.CaptureCallback ) Sets the callback to receive repeating capture updates with an executor.

Public properties
open CaptureRequestOptionTarget	captureRequest Helper target property supporting captureRequest[key] = value indexing operator syntax.
CameraCaptureSession.CaptureCallback?	repeatingCaptureCallback The callback to receive repeating capture updates on a direct executor.
Int	repeatingCaptureRequestTemplate The repeating capture request template type (e.g., android.hardware.camera2.CameraDevice.TEMPLATE_PREVIEW).

Public functions

clearAllCaptureRequestOptions

Added in 1.7.0-rc01

fun clearAllCaptureRequestOptions(): Unit

Clears all CaptureRequest.Keys previously set on this target.

clearCaptureRequestOption

Added in 1.7.0-rc01

fun clearCaptureRequestOption(key: CaptureRequest.Key<*>): Unit

Clears a CaptureRequest.Key previously set on this target.

Parameters
key: CaptureRequest.Key<*>	capture request option key

setCaptureRequestOption

Added in 1.7.0-rc01

fun <V : Any?> setCaptureRequestOption(key: CaptureRequest.Key<V>, value: V): Unit

Sets a CaptureRequest.Key and value on repeating and one-shot requests.

Parameters
key: CaptureRequest.Key<V>	capture request option key
value: V	option value

setRepeatingCaptureCallback

Added in 1.7.0-rc01

fun setRepeatingCaptureCallback(
    executor: Executor,
    callback: CameraCaptureSession.CaptureCallback
): Unit

Sets the callback to receive repeating capture updates with an executor.

Warning: The callback receives raw android.hardware.camera2.CameraCaptureSession instances. Directly invoking state-altering, lifecycle, or request-submitting methods on these raw objects bypasses CameraX pipeline management and causes state desynchronization, stream freezing, or crashes. Do not invoke:

• Session lifecycle methods: android.hardware.camera2.CameraCaptureSession.close, android.hardware.camera2.CameraCaptureSession.abortCaptures, or android.hardware.camera2.CameraCaptureSession.stopRepeating

• Request submission methods: android.hardware.camera2.CameraCaptureSession.setRepeatingRequest, android.hardware.camera2.CameraCaptureSession.setRepeatingBurst, android.hardware.camera2.CameraCaptureSession.capture, or android.hardware.camera2.CameraCaptureSession.captureBurst

• Surface / output configuration methods: android.hardware.camera2.CameraCaptureSession.updateOutputConfiguration, android.hardware.camera2.CameraCaptureSession.finalizeOutputConfigurations, android.hardware.camera2.CameraCaptureSession.prepare, or android.hardware.camera2.CameraCaptureSession.switchToOffline

Parameters
executor: Executor	executor to run the callback on
callback: CameraCaptureSession.CaptureCallback	repeating capture callback

Public properties

captureRequest

Added in 1.7.0-rc01

open val captureRequest: CaptureRequestOptionTarget

Helper target property supporting captureRequest[key] = value indexing operator syntax.

repeatingCaptureCallback

Added in 1.7.0-rc01

var repeatingCaptureCallback: CameraCaptureSession.CaptureCallback?

The callback to receive repeating capture updates on a direct executor.

Warning: The callback receives raw android.hardware.camera2.CameraCaptureSession instances. Directly invoking state-altering, lifecycle, or request-submitting methods on these raw objects bypasses CameraX pipeline management and causes state desynchronization, stream freezing, or crashes. Do not invoke:

• Session lifecycle methods: android.hardware.camera2.CameraCaptureSession.close, android.hardware.camera2.CameraCaptureSession.abortCaptures, or android.hardware.camera2.CameraCaptureSession.stopRepeating

• Request submission methods: android.hardware.camera2.CameraCaptureSession.setRepeatingRequest, android.hardware.camera2.CameraCaptureSession.setRepeatingBurst, android.hardware.camera2.CameraCaptureSession.capture, or android.hardware.camera2.CameraCaptureSession.captureBurst

• Surface / output configuration methods: android.hardware.camera2.CameraCaptureSession.updateOutputConfiguration, android.hardware.camera2.CameraCaptureSession.finalizeOutputConfigurations, android.hardware.camera2.CameraCaptureSession.prepare, or android.hardware.camera2.CameraCaptureSession.switchToOffline

repeatingCaptureRequestTemplate

Added in 1.7.0-rc01

var repeatingCaptureRequestTemplate: Int

The repeating capture request template type (e.g., android.hardware.camera2.CameraDevice.TEMPLATE_PREVIEW).