CameraConstrainedHighSpeedCaptureSession

Class Overview

A constrained high speed capture session for a CameraDevice, used for capturing high speed images from the CameraDevice for high speed video recording use case.

A CameraHighSpeedCaptureSession is created by providing a set of target output surfaces to createConstrainedHighSpeedCaptureSession(List, CameraCaptureSession.StateCallback, Handler), Once created, the session is active until a new session is created by the camera device, or the camera device is closed.

An active high speed capture session is a specialized capture session that is only targeted at high speed video recording (>=120fps) use case if the camera device supports high speed video capability (i.e., REQUEST_AVAILABLE_CAPABILITIES contains REQUEST_AVAILABLE_CAPABILITIES_CONSTRAINED_HIGH_SPEED_VIDEO). It only accepts request lists created via createHighSpeedRequestList(CaptureRequest), and the request list can only be submitted to this session via captureBurst, or setRepeatingBurst. See createConstrainedHighSpeedCaptureSession(List, CameraCaptureSession.StateCallback, Handler) for more details of the limitations.

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 createConstrainedHighSpeedCaptureSession(List, CameraCaptureSession.StateCallback, Handler) will send the ready-to-use CameraCaptureSession to the provided listener's onConfigured(CameraCaptureSession) callback. If configuration cannot be completed, then the onConfigureFailed(CameraCaptureSession) is called, and the session will not become active.

If a new session is created by the camera device, then the previous session is closed, and its associated 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.

Summary

[Expand] Inherited Methods
From class android.hardware.camera2.CameraCaptureSession abstract void abortCaptures() Discard all captures currently pending and in-progress as fast as possible. abstract int capture(CaptureRequest request, CameraCaptureSession.CaptureCallback listener, Handler handler) Submit a request for an image to be captured by the camera device. abstract int captureBurst(List<CaptureRequest> requests, CameraCaptureSession.CaptureCallback listener, Handler handler) Submit a list of requests to be captured in sequence as a burst. abstract void close() Close this capture session asynchronously. abstract CameraDevice getDevice() Get the camera device that this session is created for. abstract Surface getInputSurface() Get the input Surface associated with a reprocessable capture session. abstract boolean isReprocessable() Return if the application can submit reprocess capture requests with this camera capture session. abstract void prepare(Surface surface) Pre-allocate all buffers for an output Surface. abstract int setRepeatingBurst(List<CaptureRequest> requests, CameraCaptureSession.CaptureCallback listener, Handler handler) Request endlessly repeating capture of a sequence of images by this capture session. abstract int setRepeatingRequest(CaptureRequest request, CameraCaptureSession.CaptureCallback listener, Handler handler) Request endlessly repeating capture of images by this capture session. abstract void stopRepeating() Cancel any ongoing repeating capture set by either setRepeatingRequest or setRepeatingBurst(List, CameraCaptureSession.CaptureCallback, Handler).
From class java.lang.Object Object clone() Creates and returns a copy of this Object. boolean equals(Object o) Compares this instance with the specified object and indicates if they are equal. void finalize() Invoked when the garbage collector has detected that this instance is no longer reachable. final Class<?> getClass() Returns the unique instance of Class that represents this object's class. int hashCode() Returns an integer hash code for this object. final void notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up. final void notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up. String toString() Returns a string containing a concise, human-readable description of this object. final void wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object. final void wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires. final void wait(long millis) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
From interface java.lang.AutoCloseable abstract void close() Closes the object and release any system resources it holds.