CameraConstrainedHighSpeedCaptureSession Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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.
[Android.Runtime.Register("android/hardware/camera2/CameraConstrainedHighSpeedCaptureSession", ApiSince=23, DoNotGenerateAcw=true)]
public abstract class CameraConstrainedHighSpeedCaptureSession : Android.Hardware.Camera2.CameraCaptureSession[<Android.Runtime.Register("android/hardware/camera2/CameraConstrainedHighSpeedCaptureSession", ApiSince=23, DoNotGenerateAcw=true)>]
type CameraConstrainedHighSpeedCaptureSession = class
inherit CameraCaptureSession- Inheritance
- Attributes
Remarks
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 CameraConstrainedHighSpeedCaptureSession is created by providing a session configuration to CameraDevice#createCaptureSession(SessionConfiguration) with a type of android.hardware.camera2.params.SessionConfiguration#SESSION_HIGH_SPEED. The CameraCaptureSession returned from CameraCaptureSession.StateCallback can then be cast to a CameraConstrainedHighSpeedCaptureSession. 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., CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES contains CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_CONSTRAINED_HIGH_SPEED_VIDEO). It only accepts request lists created via #createHighSpeedRequestList, and the request list can only be submitted to this session via CameraCaptureSession#captureBurst captureBurst, or CameraCaptureSession#setRepeatingBurst setRepeatingBurst. See CameraDevice#createCaptureSession(android.hardware.camera2.params.SessionConfiguration) 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 CameraDevice#createConstrainedHighSpeedCaptureSession will send the ready-to-use CameraCaptureSession to the provided listener's CameraCaptureSession.StateCallback#onConfigured callback. If configuration cannot be completed, then the CameraCaptureSession.StateCallback#onConfigureFailed 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 CameraCaptureSession.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.CameraConstrainedHighSpeedCaptureSession.
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
| CameraConstrainedHighSpeedCaptureSession() | |
| CameraConstrainedHighSpeedCaptureSession(IntPtr, JniHandleOwnership) |
Properties
| Class |
Returns the runtime class of this |
| Device |
Get the camera device that this session is created for. (Inherited from CameraCaptureSession) |
| Handle |
The handle to the underlying Android instance. (Inherited from Object) |
| InputSurface | (Inherited from CameraCaptureSession) |
| IsReprocessable | (Inherited from CameraCaptureSession) |
| JniIdentityHashCode | (Inherited from Object) |
| JniPeerMembers | |
| PeerReference | (Inherited from Object) |
| ThresholdClass | |
| ThresholdType | |
Methods
| AbortCaptures() |
Discard all captures currently pending and in-progress as fast as possible. (Inherited from CameraCaptureSession) |
| Capture(CaptureRequest, CameraCaptureSession+CaptureCallback, Handler) |
Submit a request for an image to be captured by the camera device. (Inherited from CameraCaptureSession) |
| CaptureBurst(IList<CaptureRequest>, CameraCaptureSession+CaptureCallback, Handler) |
Submit a list of requests to be captured in sequence as a burst. (Inherited from CameraCaptureSession) |
| CaptureBurstRequests(IList<CaptureRequest>, IExecutor, CameraCaptureSession+CaptureCallback) |
Submit a list of requests to be captured in sequence as a burst. (Inherited from CameraCaptureSession) |
| CaptureSingleRequest(CaptureRequest, IExecutor, CameraCaptureSession+CaptureCallback) |
Submit a request for an image to be captured by the camera device. (Inherited from CameraCaptureSession) |
| Clone() |
Creates and returns a copy of this object. (Inherited from Object) |
| Close() |
Close this capture session asynchronously. (Inherited from CameraCaptureSession) |
| CreateHighSpeedRequestList(CaptureRequest) |
Create a unmodifiable list of requests that is suitable for constrained high speed capture session streaming. |
| Dispose() | (Inherited from Object) |
| Dispose(Boolean) | (Inherited from Object) |
| Equals(Object) |
Indicates whether some other object is "equal to" this one. (Inherited from Object) |
| FinalizeOutputConfigurations(IList<OutputConfiguration>) |
Finalize the output configurations that now have their deferred and/or extra Surfaces included. (Inherited from CameraCaptureSession) |
| GetHashCode() |
Returns a hash code value for the object. (Inherited from Object) |
| JavaFinalize() |
Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. (Inherited from Object) |
| Notify() |
Wakes up a single thread that is waiting on this object's monitor. (Inherited from Object) |
| NotifyAll() |
Wakes up all threads that are waiting on this object's monitor. (Inherited from Object) |
| Prepare(Surface) |
Pre-allocate all buffers for an output Surface. (Inherited from CameraCaptureSession) |
| SetHandle(IntPtr, JniHandleOwnership) |
Sets the Handle property. (Inherited from Object) |
| SetRepeatingBurst(IList<CaptureRequest>, CameraCaptureSession+CaptureCallback, Handler) |
Request endlessly repeating capture of a sequence of images by this capture session. (Inherited from CameraCaptureSession) |
| SetRepeatingBurstRequests(IList<CaptureRequest>, IExecutor, CameraCaptureSession+CaptureCallback) |
Request endlessly repeating capture of a sequence of images by this capture session. (Inherited from CameraCaptureSession) |
| SetRepeatingRequest(CaptureRequest, CameraCaptureSession+CaptureCallback, Handler) |
Request endlessly repeating capture of images by this capture session. (Inherited from CameraCaptureSession) |
| SetSingleRepeatingRequest(CaptureRequest, IExecutor, CameraCaptureSession+CaptureCallback) |
Request endlessly repeating capture of images by this capture session. (Inherited from CameraCaptureSession) |
| StopRepeating() |
Cancel any ongoing repeating capture set by either
|
| SupportsOfflineProcessing(Surface) |
Query whether a given Surface is able to support offline mode. (Inherited from CameraCaptureSession) |
| SwitchToOffline(ICollection<Surface>, IExecutor, CameraOfflineSession+CameraOfflineSessionCallback) |
Switch the current capture session and a given set of registered camera surfaces to offline processing mode. (Inherited from CameraCaptureSession) |
| ToArray<T>() | (Inherited from Object) |
| ToString() |
Returns a string representation of the object. (Inherited from Object) |
| UnregisterFromRuntime() | (Inherited from Object) |
| UpdateOutputConfiguration(OutputConfiguration) |
Update |
| Wait() |
Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>. (Inherited from Object) |
| Wait(Int64) |
Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object) |
| Wait(Int64, Int32) |
Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object) |
Explicit Interface Implementations
| IJavaPeerable.Disposed() | (Inherited from Object) |
| IJavaPeerable.DisposeUnlessReferenced() | (Inherited from Object) |
| IJavaPeerable.Finalized() | (Inherited from Object) |
| IJavaPeerable.JniManagedPeerState | (Inherited from Object) |
| IJavaPeerable.SetJniIdentityHashCode(Int32) | (Inherited from Object) |
| IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates) | (Inherited from Object) |
| IJavaPeerable.SetPeerReference(JniObjectReference) | (Inherited from Object) |
Extension Methods
| JavaCast<TResult>(IJavaObject) |
Performs an Android runtime-checked type conversion. |
| JavaCast<TResult>(IJavaObject) | |
| GetJniTypeName(IJavaPeerable) | |