SessionConfigurationInterop

Artifact: androidx.camera:camera-camera2

View Source

Added in 1.7.0-alpha03

---

Kotlin |Java

public interface SessionConfigurationInterop<T extends SessionConfigurationInterop<@NonNull T>>

Known direct subclasses

SessionConfigCamera2Interop

SessionConfigCamera2Interop

Configures Camera2 options on a androidx.camera.core.SessionConfig.

---

Configures Camera2 android.hardware.camera2.params.SessionConfiguration options.

Summary

Public methods
abstract @NonNull T	@RequiresApi(value = 34) setColorSpace(int colorSpace) Sets the session color space.
abstract @NonNull T	@RequiresApi(value = 28) <V extends Object> setSessionParameter(     @NonNull CaptureRequest.Key<@NonNull V> key,     @NonNull V value ) Sets a session parameter used during session creation.
default @NonNull T	setSessionStateCallback(     @NonNull CameraCaptureSession.StateCallback callback ) Sets the callback to receive session state updates on a direct executor.
abstract @NonNull T	setSessionStateCallback(     @NonNull Executor executor,     @NonNull CameraCaptureSession.StateCallback callback ) Sets the callback to receive session state updates.
abstract @NonNull T	@RequiresApi(value = 28) setSessionType(int sessionType) Sets the operating mode session type.

Public methods

setColorSpace

Added in 1.7.0-alpha03

@RequiresApi(value = 34)
abstract @NonNull T setColorSpace(int colorSpace)

Sets the session color space.

Parameters
int colorSpace	color space

Returns
@NonNull T	this SessionConfigurationInterop instance

setSessionParameter

Added in 1.7.0-alpha03

@RequiresApi(value = 28)
abstract @NonNull T <V extends Object> setSessionParameter(
    @NonNull CaptureRequest.Key<@NonNull V> key,
    @NonNull V value
)

Sets a session parameter used during session creation.

Parameters
@NonNull CaptureRequest.Key<@NonNull V> key	session parameter key
@NonNull V value	parameter value

Returns
@NonNull T	this SessionConfigurationInterop instance

setSessionStateCallback

Added in 1.7.0-alpha03

default @NonNull T setSessionStateCallback(
    @NonNull CameraCaptureSession.StateCallback callback
)

Sets the callback to receive session state updates on a direct executor.

Warning: The callback receives raw android.hardware.camera2.CameraCaptureSession instances. Calling state-altering methods on the session (such as android.hardware.camera2.CameraCaptureSession.close or android.hardware.camera2.CameraCaptureSession.abortCaptures) bypasses CameraX pipeline management and may cause state desynchronization or application crashes.

Parameters
@NonNull CameraCaptureSession.StateCallback callback	session state callback

Returns
@NonNull T	this SessionConfigurationInterop instance

setSessionStateCallback

Added in 1.7.0-alpha03

abstract @NonNull T setSessionStateCallback(
    @NonNull Executor executor,
    @NonNull CameraCaptureSession.StateCallback callback
)

Sets the callback to receive session state updates.

Warning: The callback receives raw android.hardware.camera2.CameraCaptureSession instances. Calling state-altering methods on the session (such as android.hardware.camera2.CameraCaptureSession.close or android.hardware.camera2.CameraCaptureSession.abortCaptures) bypasses CameraX pipeline management and may cause state desynchronization or application crashes.

Parameters
@NonNull Executor executor	executor to run the callback on
@NonNull CameraCaptureSession.StateCallback callback	session state callback

Returns
@NonNull T	this SessionConfigurationInterop instance

setSessionType

Added in 1.7.0-alpha03

@RequiresApi(value = 28)
abstract @NonNull T setSessionType(int sessionType)

Sets the operating mode session type.

Parameters
int sessionType	session type

Returns
@NonNull T	this SessionConfigurationInterop instance