SessionConfigurationInterop

public interface SessionConfigurationInterop

Known direct subclasses

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

Summary

Public methods
abstract ColorSpace.Named
@RequiresApi(value = 34)
getColorSpace()

The session color space.
default @NonNull SessionParameterTarget

Helper target property supporting sessionParameter[key] = value indexing operator syntax.
abstract CameraCaptureSession.StateCallback

The callback to receive session state updates on a direct executor.
abstract int
@RequiresApi(value = 28)
getSessionType()

The operating mode session type.
abstract void

The session color space.
abstract void
@RequiresApi(value = 28)
<V extends Object> setSessionParameter(
    @NonNull CaptureRequest.Key<@NonNull V> key,
    @NonNull V value
)

Sets a session parameter used during session creation.
abstract void

The callback to receive session state updates on a direct executor.
abstract void

Sets the callback to receive session state updates with an executor.
abstract void
@RequiresApi(value = 28)
setSessionType(int value)

The operating mode session type.

Public methods

getColorSpace

Added in 1.7.0-rc01
@RequiresApi(value = 34)
abstract ColorSpace.Named getColorSpace()

The session color space.

getSessionParameter

Added in 1.7.0-rc01
@RequiresApi(value = 28)
default @NonNull SessionParameterTarget getSessionParameter()

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

getSessionStateCallback

Added in 1.7.0-rc01
abstract CameraCaptureSession.StateCallback getSessionStateCallback()

The callback to receive session state 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:

getSessionType

Added in 1.7.0-rc01
@RequiresApi(value = 28)
abstract int getSessionType()

The operating mode session type.

setColorSpace

Added in 1.7.0-rc01
@RequiresApi(value = 34)
abstract void setColorSpace(ColorSpace.Named value)

The session color space.

setSessionParameter

Added in 1.7.0-rc01
@RequiresApi(value = 28)
abstract void <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

setSessionStateCallback

Added in 1.7.0-rc01
abstract void setSessionStateCallback(CameraCaptureSession.StateCallback value)

The callback to receive session state 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:

setSessionStateCallback

Added in 1.7.0-rc01
abstract void setSessionStateCallback(
    @NonNull Executor executor,
    @NonNull CameraCaptureSession.StateCallback callback
)

Sets the callback to receive session state 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:

Parameters
@NonNull Executor executor

executor to run the callback on
@NonNull CameraCaptureSession.StateCallback callback

session state callback

setSessionType

Added in 1.7.0-rc01
@RequiresApi(value = 28)
abstract void setSessionType(int value)

The operating mode session type.