org.firstinspires.ftc.robotcore.external.hardware.camera

Interface Camera

All Superinterfaces:

CameraControls

All Known Subinterfaces:

SwitchableCamera

public interface Camera
extends CameraControls

THIS INTERFACE IS EXPERIMENTAL. Its form and function may change in whole or in part before being finalized for production use. Caveat emptor. Camera provides access to a camera that has been opened. Modelled after android.hardware.camera2.CameraDevice, but somewhat simplified.

See Also:

CameraManager.asyncOpenCameraAssumingPermission(org.firstinspires.ftc.robotcore.external.hardware.camera.CameraName, org.firstinspires.ftc.robotcore.external.function.Continuation<? extends org.firstinspires.ftc.robotcore.external.hardware.camera.Camera.StateCallback>, long, java.util.concurrent.TimeUnit), com.example.android.camera2.cameratoo.CameraTooActivity

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Camera.Error Reasons for which a Camera might have failed after opening.
static class	Camera.OpenFailure Reasons for which a Camera might have failed to open.
static interface	Camera.StateCallback
static class	Camera.StateCallbackDefault An implementation of StateCallback that does nothing by default

Method Summary

Modifier and Type	Method and Description
void	close() Close the connection to this camera device as quickly as possible.
CameraCaptureRequest	createCaptureRequest(int androidFormat, Size size, int fps) Create a capture request.
CameraCaptureSession	createCaptureSession(Continuation<? extends CameraCaptureSession.StateCallback> continuation) Creates a capture session for this device.
Camera	dup() Returns another Camera on the same underlying device with an independent close() effect.
CameraName	getCameraName() Returns the name of this camera device.

Methods inherited from interface org.firstinspires.ftc.robotcore.external.hardware.camera.CameraControls

getControl

Method Detail

getCameraName

CameraName getCameraName()

Returns the name of this camera device.

This method can be called even if the device has been closed or has encountered a serious error.

Returns:

the name for this camera device

See Also:

CameraManager.getAllWebcams()

createCaptureRequest

CameraCaptureRequest createCaptureRequest(int androidFormat,
                                          Size size,
                                          int fps)
                                   throws CameraException

Create a capture request. Capture requests contain the set of parameters used to configure a given capture operations.

Throws:

CameraException

See Also:

CameraCaptureSession.startCapture(org.firstinspires.ftc.robotcore.external.hardware.camera.CameraCaptureRequest, org.firstinspires.ftc.robotcore.external.hardware.camera.CameraCaptureSession.CaptureCallback, org.firstinspires.ftc.robotcore.external.function.Continuation<? extends org.firstinspires.ftc.robotcore.external.hardware.camera.CameraCaptureSession.StatusCallback>)

createCaptureSession

CameraCaptureSession createCaptureSession(Continuation<? extends CameraCaptureSession.StateCallback> continuation)
                                   throws CameraException

Creates a capture session for this device. Only one capture session may be extant at any given time: any extant session is closed if a new one is created. If the creation of the capture session is successful, then CameraCaptureSession.StateCallback.onConfigured(CameraCaptureSession) is called. If the creation fails, then an exception is thrown.

Throws:

CameraException

close

void close()

Close the connection to this camera device as quickly as possible.

Immediately after this call, all calls to the camera device or active session interface will throw a IllegalStateException, except for calls to close(). Once the device has fully shut down, the Camera.StateCallback.onClosed(org.firstinspires.ftc.robotcore.external.hardware.camera.Camera) callback will be called.

Immediately after this call, besides the final Camera.StateCallback.onClosed(org.firstinspires.ftc.robotcore.external.hardware.camera.Camera) calls, no further callbacks from the device or the active session will occur, and any remaining submitted capture requests will be discarded, and no success or failure callbacks will be invoked.

dup

Camera dup()

Returns another Camera on the same underlying device with an independent close() effect. The analogy is that of dup()ing open file descriptors in Linux / Unix.