ExtensionSessionConfig

Artifact: androidx.camera:camera-extensions

Kotlin |Java

class ExtensionSessionConfig : SessionConfig

kotlin.Any
↳	androidx.camera.core.SessionConfig
	↳	androidx.camera.extensions.ExtensionSessionConfig

A SessionConfig for extension sessions.

This class encapsulates the necessary configurations for a extension session. Once configured, this config can be bound to a camera and lifecycle using androidx.camera.lifecycle.ProcessCameraProvider.bindToLifecycle or androidx.camera.lifecycle.LifecycleCameraProvider.bindToLifecycle.

It consists of a collection of UseCase, session parameters to be applied on the camera session, and common properties like the field-of-view defined by ViewPort. Note that ImageAnalysis is not supported in extension sessions.

Constraints:

When used for binding to a camera via androidx.camera.lifecycle.ProcessCameraProvider.bindToLifecycle or androidx.camera.lifecycle.LifecycleCameraProvider.bindToLifecycle, the list of UseCase provided to the constructor or added via Builder.addUseCase cannot be empty.

Apps can use CameraProvider.getCameraInfo with an ExtensionSessionConfig to obtain the CameraInfo of the camera which can support the given ExtensionSessionConfig.

Usage Example:

// In a coroutine scope
try {
    val extensionsManager = ExtensionsManager.getInstanceAsync(context, cameraProvider).await()

    val cameraSelector = CameraSelector.DEFAULT_BACK_CAMERA
    if (extensionsManager.isExtensionAvailable(cameraSelector, ExtensionMode.NIGHT)) {
        // This is the correct time to create an ExtensionSessionConfig
        val imageCapture = ImageCapture.Builder().build()
        val preview = Preview.Builder().build()

        val config = ExtensionSessionConfig.Builder(
            ExtensionMode.NIGHT,
            extensionsManager
        )
        .addUseCase(preview)
        .addUseCase(imageCapture)
        .build()

        // Now it's safe to bind the configuration
        cameraProvider.bindToLifecycle(lifecycleOwner, cameraSelector, config)
    } else {
        // Handle the case where the extension is not available.
    }
} catch (e: Exception) {
    // Handle failure
}

Throws
`kotlin.IllegalArgumentException`	if the given mode is not a valid extension mode.

See also
`bindToLifecycle`
`getInstanceAsync`

Summary

Nested types
`class ExtensionSessionConfig.Builder` Builder for `ExtensionSessionConfig`.

Public constructors
`ExtensionSessionConfig( mode: Int, extensionsManager: ExtensionsManager, vararg useCases: UseCase )` Creates an `ExtensionSessionConfig` with a variable number of `UseCase` instances.
`ExtensionSessionConfig( mode: Int, extensionsManager: ExtensionsManager, useCases: List<UseCase>, viewPort: ViewPort?, effects: List<CameraEffect> )`

Public properties
`ExtensionsManager`	`extensionsManager` The `ExtensionsManager` instance.
`Int`	`mode` The extension mode.

Inherited functions

From androidx.camera.core.SessionConfig

`Unit`	`setFeatureSelectionListener( executor: Executor, listener: Consumer<Set<GroupableFeature>> )` Sets a listener to know which features are finally selected when a session config is bound, based on the user-defined priorities/ordering for `preferredFeatureGroup` and device capabilities.
`open String`	`toString()`

Inherited properties

From androidx.camera.core.SessionConfig

`List<CameraEffect>`	`effects` The list of `CameraEffect` to be applied on the camera session.
`Consumer<Set<GroupableFeature>>`	`featureSelectionListener` Gets the feature selection listener set to this session config.
`Executor`	`featureSelectionListenerExecutor` Gets the executor set to this session config for feature selection listener invocation.
`Range<Int>`	`frameRateRange` The desired frame rate range for the camera session.
`List<GroupableFeature>`	`preferredFeatureGroup` A list of preferred `GroupableFeature` ordered according to priority in descending order, i.e. a feature with a lower index in the list is considered to have a higher priority.
`Set<GroupableFeature>`	`requiredFeatureGroup` A set of `GroupableFeature` that are mandatory for the camera session configuration.
`List<UseCase>`	`useCases` The list of `UseCase` to be attached to the camera and receive camera data.
`ViewPort?`	`viewPort` The `ViewPort` to be applied on the camera session.

Public constructors