CameraCaptureSession Class

Definition

[Android.Runtime.Register("android/hardware/camera2/CameraCaptureSession", DoNotGenerateAcw=true)]
public abstract class CameraCaptureSession : Java.Lang.Object, IDisposable, Java.Interop.IJavaPeerable, Java.Lang.IAutoCloseable

[<Android.Runtime.Register("android/hardware/camera2/CameraCaptureSession", DoNotGenerateAcw=true)>]
type CameraCaptureSession = class
    inherit Object
    interface IAutoCloseable
    interface IJavaObject
    interface IDisposable
    interface IJavaPeerable

Inheritance

Object

Object

CameraCaptureSession

Derived

Android.Hardware.Camera2.CameraConstrainedHighSpeedCaptureSession

Android.Hardware.Camera2.CameraOfflineSession

Attributes

RegisterAttribute

Implements

IJavaObject IJavaPeerable IAutoCloseable IDisposable

Remarks

A configured capture session for a CameraDevice, used for capturing images from the camera or reprocessing images captured from the camera in the same session previously.

A CameraCaptureSession is created by providing a set of target output surfaces to CameraDevice#createCaptureSession createCaptureSession, or by providing an android.hardware.camera2.params.InputConfiguration and a set of target output surfaces to CameraDevice#createReprocessableCaptureSession createReprocessableCaptureSession for a reprocessable capture session. Once created, the session is active until a new session is created by the camera device, or the camera device is closed.

All capture sessions can be used for capturing images from the camera but only reprocessable capture sessions can reprocess images captured from the camera in the same session previously.

Creating a session is an expensive operation and can take several hundred milliseconds, since it requires configuring the camera device's internal pipelines and allocating memory buffers for sending images to the desired targets. Therefore the setup is done asynchronously, and CameraDevice#createCaptureSession createCaptureSession and CameraDevice#createReprocessableCaptureSession createReprocessableCaptureSession will send the ready-to-use CameraCaptureSession to the provided listener's CameraCaptureSession.StateCallback#onConfigured onConfigured callback. If configuration cannot be completed, then the CameraCaptureSession.StateCallback#onConfigureFailed onConfigureFailed is called, and the session will not become active.

<!--

Any capture requests (repeating or non-repeating) submitted before the session is ready will be queued up and will begin capture once the session becomes ready. In case the session cannot be configured and StateCallback#onConfigureFailed onConfigureFailed is called, all queued capture requests are discarded.

-->

If a new session is created by the camera device, then the previous session is closed, and its associated StateCallback#onClosed onClosed callback will be invoked. All of the session methods will throw an IllegalStateException if called once the session is closed.

A closed session clears any repeating requests (as if #stopRepeating had been called), but will still complete all of its in-progress capture requests as normal, before a newly created session takes over and reconfigures the camera device.

Java documentation for android.hardware.camera2.CameraCaptureSession.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Constructors

Properties

Methods

Explicit Interface Implementations

Extension Methods

Applies to