Camera2Interop.Extender

<T : Any?> Extender(baseBuilder: ExtendableBuilder<T>)

Creates an Extender that can be used to add Camera2 options to another Builder.

fun <ValueT : Any?> setCaptureRequestOption(
    key: CaptureRequest.Key<ValueT>,
    value: ValueT
): Camera2Interop.Extender<T>

Sets a CaptureRequest.Key and Value on the configuration.

The value will override any value set by CameraX internally with the risk of interfering with some CameraX CameraControl APIs as well as 3A behavior. When applied to an androidx.camera.core.ImageCapture.Builder, options set for still capture requests override corresponding keys set in repeating requests.

fun setDeviceStateCallback(stateCallback: CameraDevice.StateCallback): Camera2Interop.Extender<T>

Sets a CameraDevice.StateCallback.

The caller is expected to use the CameraDevice instance accessed through the callback methods responsibly. Generally safe usages include: (1) querying the device for its id, (2) using the callbacks to determine what state the device is currently in. Generally unsafe usages include: (1) creating a new CameraCaptureSession, (2) creating a new CaptureRequest, (3) closing the device. When the caller uses the device beyond the safe usage limits, the usage may still work in conjunction with CameraX, but any strong guarantees provided by CameraX about the validity of the camera state become void.

@RequiresApi(value = 28)
fun setPhysicalCameraId(cameraId: String): Camera2Interop.Extender<T>

Set the ID of the physical camera to get output from.

In the case one logical camera is made up of multiple physical cameras, this call forces the physical camera with the specified camera ID to produce image.

The valid physical camera IDs can be queried by CameraCharacteristics .getPhysicalCameraIds on API >= 28. Passing in an invalid physical camera ID will be ignored.

On API <= 27, the physical camera ID will be ignored since logical camera is not supported on these API levels.

Currently it doesn't support binding use cases with different physical camera IDs. If use cases with different physical camera IDs are bound at the same time, an IllegalArgumentException will be thrown.

fun setSessionCaptureCallback(
    captureCallback: CameraCaptureSession.CaptureCallback
): Camera2Interop.Extender<T>

Sets a CameraCaptureSession.CaptureCallback.

The caller is expected to use the CameraCaptureSession instance accessed through the callback methods responsibly. Generally safe usages include: (1) querying the session for its properties. Generally unsafe usages include: (1) submitting a new CaptureRequest, (2) stopping an existing CaptureRequest, (3) closing the session, (4) attaching a new android.view.Surface to the session. When the caller uses the session beyond the safe usage limits, the usage may still work in conjunction with CameraX, but any strong guarantees provided by CameraX about the validity of the camera state become void.

The caller is generally free to use the CaptureRequest and CaptureRequest instances accessed through the callback methods.

fun setSessionStateCallback(
    stateCallback: CameraCaptureSession.StateCallback
): Camera2Interop.Extender<T>

Sets a CameraCaptureSession.StateCallback.

The caller is expected to use the CameraCaptureSession instance accessed through the callback methods responsibly. Generally safe usages include: (1) querying the session for its properties, (2) using the callbacks to determine what state the session is currently in. Generally unsafe usages include: (1) submitting a new CameraCaptureSession, (2) stopping an existing CaptureRequest, (3) closing the session, (4) attaching a new android.view.Surface to the session. When the caller uses the session beyond the safe usage limits, the usage may still work in conjunction with CameraX, but any strong guarantees provided by CameraX about the validity of the camera state become void.

@RequiresApi(value = 33)
fun setStreamUseCase(streamUseCase: Long): Camera2Interop.Extender<T>

Sets a stream use case flag on the given extendable builder.

Requires API 33 or above.

Calling this method will set the stream useCase for the stream associated with the surface whose container class is the UseCase. Valid use cases available on devices can be found in android.hardware.camera2.CameraCharacteristics.SCALER_AVAILABLE_STREAM_USE_CASES The app should make sure the input argument is in the list of supported use cases first.

If a unsupported value is provided, IllegalArgumentException will be thrown.