Android Guides | Samples

Android.Hardware.Camera2 Namespace

The android.hardware.camera2 package provides an interface to individual camera devices connected to an Android device.

Remarks

The android.hardware.camera2 package provides an interface to individual camera devices connected to an Android device. It replaces the deprecated Camera class.

This package models a camera device as a pipeline, which takes in input requests for capturing a single frame, captures the single image per the request, and then outputs one capture result metadata packet, plus a set of output image buffers for the request. The requests are processed in-order, and multiple requests can be in flight at once. Since the camera device is a pipeline with multiple stages, having multiple requests in flight is required to maintain full framerate on most Android devices.

To enumerate, query, and open available camera devices, obtain a CameraManager instance.

Individual CameraDevice provide a set of static property information that describes the hardware device and the available settings and output parameters for the device. This information is provided through the CameraCharacteristics object, and is available through CameraManager.GetCameraCharacteristics(String)

To capture or stream images from a camera device, the application must first create a CameraCaptureSession with a set of output Surfaces for use with the camera device, with droid.hardware.camera2.CameraCaptureSession.StateCallback,. Each Surface has to be pre-configured with an StreamConfigurationMap (if applicable) to match the sizes and formats available from the camera device. A target Surface can be obtained from a variety of classes, including SurfaceView, SurfaceTexture via Surface.Surface(SurfaceTexture), MediaCodec, MediaRecorder, Allocation, and ImageReader.

Generally, camera preview images are sent to SurfaceView or TextureView (via its SurfaceTexture). Capture of JPEG images or RAW buffers for DngCreator can be done with ImageReader with the ImageFormat.Jpeg and ImageFormat.RawSensor formats. Application-driven processing of camera data in RenderScript, OpenGL ES, or directly in managed or native code is best done through Allocation with a YUV Type, SurfaceTexture, and ImageReader with a ImageFormat.Yuv420888 format, respectively.

The application then needs to construct a CaptureRequest, which defines all the capture parameters needed by a camera device to capture a single image. The request also lists which of the configured output Surfaces should be used as targets for this capture. The CameraDevice has a CameraDevice.CreateCaptureRequest(CameraTemplate) for creating a NoType:android/hardware/camera2/CaptureRequest$Builder;Href=../../../../reference/android/hardware/camera2/CaptureRequest.Builder.html for a given use case, which is optimized for the Android device the application is running on.

Once the request has been set up, it can be handed to the active capture session either for a one-shot Android.Hardware.Camera2.CameraCaptureSession.Capture(Android.Hardware.Camera2.CaptureRequest, .CaptureCallback, .CaptureCallback) or for an endlessly Android.Hardware.Camera2.CameraCaptureSession.SetRepeatingRequest(Android.Hardware.Camera2.CaptureRequest, .CaptureCallback, .CaptureCallback) use. Both methods also have a variant that accepts a list of requests to use as a burst capture / repeating burst. Repeating requests have a lower priority than captures, so a request submitted through capture() while there's a repeating request configured will be captured before any new instances of the currently repeating (burst) capture will begin capture.

After processing a request, the camera device will produce a TotalCaptureResult object, which contains information about the state of the camera device at time of capture, and the final settings used. These may vary somewhat from the request, if rounding or resolving contradictory parameters was necessary. The camera device will also send a frame of image data into each of the output Surfaces included in the request. These are produced asynchronously relative to the output CaptureResult, sometimes substantially later.

Classes

TypeReason
CameraAccessErrorTypeEnumerates values returned by several types and taken as a parameter of several methods of CameraAccessException.
CameraAccessException
CameraCaptureSessionA 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.
CameraCaptureSession+CaptureCallback
CameraCaptureSession+StateCallback
CameraCharacteristics
CameraCharacteristics+Key
CameraDevice
CameraDevice+StateCallback
CameraErrorEnumerates values returned by several methods of CameraError and taken as a parameter of the CameraDevice+StateCallback.OnError member.
CameraManager
CameraManager+AvailabilityCallback
CameraMetadataThe base class for camera controls and information.
CameraTemplateEnumerates values returned by several methods of CameraTemplate and taken as a parameter of the CameraDevice.CreateCaptureRequest member.
CaptureFailureA report of failed capture for a single image capture from the image sensor.
CaptureFailureReasonEnumerates values returned by the CaptureFailure.Reason, CaptureFailureReason.Error, and CaptureFailureReason.Flushed members.
CaptureRequest
CaptureRequest+Builder
CaptureRequest+InterfaceConsts
CaptureRequest+Key
CaptureResult
CaptureResult+Key
ColorCorrectionAberrationModeEnumerates values returned by the ColorCorrectionAberrationMode.Fast, ColorCorrectionAberrationMode.HighQuality, and ColorCorrectionAberrationMode.Off members.
ColorCorrectionModeEnumerates values returned by the ColorCorrectionMode.Fast, ColorCorrectionMode.HighQuality, and ColorCorrectionMode.TransformMatrix members.
ControlAEAntibandingEnumerates values returned by several methods of ControlAEAntibanding.
ControlAEModeEnumerates values returned by several methods of ControlAEMode.
ControlAEPrecaptureTriggerEnumerates values returned by the ControlAEPrecaptureTrigger.Idle, and ControlAEPrecaptureTrigger.Start members.
ControlAEStateEnumerates values returned by several methods of ControlAEState.
ControlAFModeEnumerates values returned by several methods of ControlAFMode.
ControlAFStateEnumerates values returned by several methods of ControlAFState.
ControlAFTriggerEnumerates values returned by the ControlAFTrigger.Cancel, ControlAFTrigger.Idle, and ControlAFTrigger.Start members.
ControlAwbModeEnumerates values returned by several methods of ControlAwbMode.
ControlAwbStateEnumerates values returned by several methods of ControlAwbState.
ControlCaptureIntentEnumerates values returned by several methods of ControlCaptureIntent.
ControlEffectModeEnumerates values returned by several methods of ControlEffectMode.
ControlModeEnumerates values returned by several methods of ControlMode.
ControlSceneModeEnumerates values returned by several methods of ControlSceneMode.
ControlVideoStabilizationModeEnumerates values returned by the ControlVideoStabilizationMode.Off, and ControlVideoStabilizationMode.On members.
DngCreatorThe DngCreator class provides functions to write raw pixel data as a DNG file.
EdgeModeEnumerates values returned by the EdgeMode.Fast, EdgeMode.HighQuality, and EdgeMode.Off members.
FlashModeEnumerates values returned by the FlashMode.Off, FlashMode.Single, and FlashMode.Torch members.
FlashStateEnumerates values returned by several methods of FlashState.
HotPixelModeEnumerates values returned by the HotPixelMode.Fast, HotPixelMode.HighQuality, and HotPixelMode.Off members.
InfoSupportedHardwareLevelEnumerates values returned by the InfoSupportedHardwareLevel.Full, InfoSupportedHardwareLevel.Legacy, and InfoSupportedHardwareLevel.Limited members.
LensFacingEnumerates values returned by the LensFacing.Back, and LensFacing.Front members.
LensInfoFocusDistanceCalibrationEnumerates values returned by the LensInfoFocusDistanceCalibration.Approximate, LensInfoFocusDistanceCalibration.Calibrated, and LensInfoFocusDistanceCalibration.Uncalibrated members.
LensOpticalStabilizationModeEnumerates values returned by the LensOpticalStabilizationMode.Off, and LensOpticalStabilizationMode.On members.
LensStateEnumerates values returned by the LensState.Moving, and LensState.Stationary members.
NoiseReductionModeEnumerates values returned by the NoiseReductionMode.Fast, NoiseReductionMode.HighQuality, and NoiseReductionMode.Off members.
RequestAvailableCapabilitiesEnumerates values returned by several methods of RequestAvailableCapabilities.
ScalerCroppingTypeEnumerates values returned by the ScalerCroppingType.CenterOnly, and ScalerCroppingType.Freeform members.
SensorInfoColorFilterArrangementEnumerates values returned by several methods of SensorInfoColorFilterArrangement.
SensorInfoTimestampSourceEnumerates values returned by the SensorInfoTimestampSource.Realtime, and SensorInfoTimestampSource.Unknown members.
SensorReferenceIlluminant1Enumerates values returned by several methods of SensorReferenceIlluminant1.
SensorTestPatternModeEnumerates values returned by several methods of SensorTestPatternMode.
ShadingModeEnumerates values returned by the ShadingMode.Fast, ShadingMode.HighQuality, and ShadingMode.Off members.
StatisticsFaceDetectModeEnumerates values returned by the StatisticsFaceDetectMode.Full, StatisticsFaceDetectMode.Off, and StatisticsFaceDetectMode.Simple members.
StatisticsLensShadingMapModeEnumerates values returned by the StatisticsLensShadingMapMode.Off, and StatisticsLensShadingMapMode.On members.
StatisticsSceneFlickerEnumerates values returned by the StatisticsSceneFlicker.None, StatisticsSceneFlicker.S50hz, and StatisticsSceneFlicker.S60hz members.
SyncMaxLatencyEnumerates values returned by the SyncMaxLatency.PerFrameControl, and SyncMaxLatency.Unknown members.
TonemapModeEnumerates values returned by the TonemapMode.ContrastCurve, TonemapMode.Fast, and TonemapMode.HighQuality members.
TotalCaptureResult