BaseCamera	The base camera interface.
Camera	The camera interface is used to control the flow of data to use cases, control the camera via the CameraControl, and publish the state of the camera via CameraInfo.
CameraCaptureResult	The result of a single image capture.
CameraControl	The CameraControl provides various asynchronous operations like zoom, focus and metering which affects output of all UseCases currently bound to that camera.
CameraControlInternal	The CameraControlInternal Interface.
CameraControlInternal.ControlUpdateListener	Listener called when CameraControlInternal need to notify event.
CameraDeviceConfig	Configuration containing options for configuring a Camera device.
CameraDeviceConfig.Builder<B>	Builder for a CameraDeviceConfig.
CameraDeviceSurfaceManager	Camera device manager to provide the guaranteed supported stream capabilities related info for all camera devices
CameraFactory	The factory class that creates BaseCamera instances.
CameraFilter	An interface for filtering cameras.
CameraIdFilter	A filter selects certain type of camera id from a camera id set.
CameraInfo	An interface for retrieving camera information.
CameraInfoInternal	An interface for retrieving camera information.
CameraProvider	A CameraProvider provides basic access to a set of cameras such as querying for camera existence or information.
CameraXConfig.Provider	An interface which can be implemented to provide the configuration for CameraX.
CaptureBundle	A interface to return an ordered collection of CaptureStage.
CaptureConfig.OptionUnpacker	Interface for unpacking a configuration into a CaptureConfig.Builder
CaptureProcessor	A processing step of the image capture pipeline.
CaptureStage	A CaptureConfig with an identifier.
Config	A Configuration is a collection of options and values.
Config.ExtendableBuilder	Extendable builders are used to add externally defined options to a configuration.
Config.OptionMatcher	A callback for retrieving results of a Config.Option search.
ConfigProvider<C>	A class which provides a Config object.
DeferrableSurface.OnSurfaceDetachedListener	The listener to be called when surface is detached totally.
ExposureState	An interface which contains the camera exposure related information.
ExtendableBuilder<T>	Extendable builders are used to add externally defined options that can be passed to the implementation being built.
ForwardingImageProxy.OnImageCloseListener	Listener for the image close event.
ImageAnalysis.Analyzer	Interface for analyzing images.
ImageCapture.OnImageSavedCallback	Listener containing callbacks for image file I/O events.
ImageCapture.ScreenFlash	Interface to do the application changes required for screen flash operations.
ImageCapture.ScreenFlashListener	Callback listener for discovering when the application has completed its changes for a screen flash image capture.
ImageCaptureCapabilities	ImageCaptureCapabilities is used to query ImageCapture use case capabilities on the device.
ImageInfo	Metadata for an image.
ImageInfoProcessor	A processing step that updates the necessary CaptureStage based on the current ImageInfo.
ImageOutputConfig	Configuration containing options for configuring the output image data of a pipeline.
ImageOutputConfig.Builder<B>	Builder for a ImageOutputConfig.
ImageProcessor	Post-processing effect for images.
ImageProcessor.Request	A request for processing one or multiple ImageProxy.
ImageProcessor.Response	A response for returning a processed ImageProxy to CameraX.
ImageProxy	An image proxy which has a similar interface as .
ImageProxy.PlaneProxy	A plane proxy which has an analogous interface as .
ImageProxyBundle	A set of ImageProxy which are mapped an identifier.
ImageReaderProxy	An image reader proxy which has an analogous interface as .
ImageReaderProxy.OnImageAvailableListener	A listener for newly available images.
ImageReaderProxyProvider	Provider that provides a ImageReaderProxy instance.
MutableConfig	MutableConfig is a Config that can be modified.
Observable<T>	An observable stream which contains data or errors.
Observable.Observer<T>	A callback that can receive new values and errors from an Observable.
Preview.SurfaceProvider	A interface implemented by the application to provide a for Preview.
PreviewCapabilities	PreviewCapabilities is used to query Preview use case capabilities on the device.
RetryPolicy	Defines a strategy for retrying upon initialization failures of the CameraProvider.
RetryPolicy.ExecutionState	Provides insights into the current execution state of the camera initialization process.
SessionConfig.ErrorListener	Callback for errors that occur when accessing the session config.
SessionConfig.OptionUnpacker	Interface for unpacking a configuration into a SessionConfig.Builder
SurfaceOutput	A for drawing processed camera frames.
SurfaceProcessor	Interface to implement a GPU-based post-processing effect.
SurfaceRequest.TransformationInfoListener	Listener that receives updates of the SurfaceRequest.TransformationInfo associated with the SurfaceRequest.
TargetConfig<T>	Configuration containing options used to identify the target class and object being configured.
TargetConfig.Builder<T, B>	Builder for a TargetConfig.
UseCase.StateChangeCallback	Callback for when a UseCase transitions between active/inactive states.
UseCaseConfig<T>	Configuration containing options for use cases.
UseCaseConfig.Builder<T, C, B>	Builder for a UseCaseConfig.
UseCaseConfigFactory	A Repository for generating use case configurations.
UseCaseEventConfig	Configuration containing options pertaining to EventListener object.
UseCaseEventConfig.Builder<B>	Builder for a UseCaseEventConfig.
VideoCapture.OnVideoSavedCallback	Listener containing callbacks for video file I/O events.
ZoomState	An interface which contains the zoom related information from a camera.

Classes

AppConfig	Configuration for adding implementation and user-specific behavior to CameraX.
AppConfig.Builder	A builder for generating AppConfig objects.
AspectRatio	The aspect ratio of the use case.
CameraCaptureCallback	A callback object for tracking the progress of a capture request submitted to the camera device.
CameraCaptureCallbacks	Different implementations of CameraCaptureCallback.
CameraCaptureCallbacks.ComboCameraCaptureCallback	A CameraCaptureCallback which contains a list of CameraCaptureCallback and will propagate received callback to the list.
CameraCaptureFailure	A report of failed capture for a single image capture.
CameraCaptureMetaData	This class defines the enumeration constants used for querying the camera capture mode and results.
CameraCaptureResult.EmptyCameraCaptureResult	An implementation of CameraCaptureResult which always return default results.
CameraCaptureResults	Utility functionality for CameraCaptureResult.
CameraCaptureSessionStateCallbacks	Different implementations of .
CameraDeviceStateCallbacks	Different implementations of .
CameraEffect	An effect for one or multiple camera outputs.
CameraExecutor	A camera executor class that executes camera operations.
CameraIdFilterSet	A CameraIdFilter which holds multiple CameraIdFilter and filters camera ids with all of them.
CameraOrientationUtil	Contains utility methods related to camera orientation.
CameraRepository	A collection of BaseCamera instances.
CameraSelector	A set of requirements and priorities used to select a camera or return a filtered set of cameras.
CameraSelector.Builder	Builder for a CameraSelector.
CameraState	Represents the different states the camera can be in.
CameraState.StateError	Error that the camera has encountered.
CameraX	Main interface for accessing CameraX library.
CameraXConfig	A configuration for adding implementation and user-specific behavior to CameraX.
CameraXConfig.Builder	A builder for generating CameraXConfig objects.
CameraXThreads	Static tag for creating CameraX threads.
CaptureBundles	Different implementations of CaptureBundle.
CaptureConfig	Configurations needed for a capture request.
CaptureConfig.Builder	Builder for easy modification/rebuilding of a CaptureConfig.
CaptureStage.DefaultCaptureStage	A capture stage which contains no additional implementation options
CompositionSettings	Composition settings for dual concurrent camera.
CompositionSettings.Builder	A builder for CompositionSettings instances.
ConcurrentCamera	Concurrent camera is a new feature introduced from Android 11, which supports simultaneous streaming of camera devices, for example, it allows a device to have both the front and back cameras operating at the same time.
ConcurrentCamera.SingleCameraConfig	Configuration for a single camera in concurrent camera mode, including CameraSelector, LifecycleOwner and UseCaseGroup.
Config.Option<T>	An Config.Option is used to set and retrieve values for settings defined in a Config.
DeferrableSurface	A reference to a whose creation can be deferred to a later time.
DeferrableSurfaces	Utility functions for manipulating DeferrableSurface.
DeviceProperties	Container of the device properties.
DisplayOrientedMeteringPointFactory	A MeteringPointFactory that can convert a `View` (x, y) into a MeteringPoint which can then be used to construct a FocusMeteringAction to start a focus and metering action.
DynamicRange	A representation of the dynamic range of an image.
ErrorHandler	Handler for sending and receiving error messages.
Exif	Utility class for modifying metadata on JPEG files.
ExtendableUseCaseConfigFactory	A UseCaseConfigFactory that uses ConfigProviders to provide configurations.
FocusMeteringAction	A configuration used to trigger a focus and/or metering action.
FocusMeteringAction.Builder	The builder used to create the FocusMeteringAction.
FocusMeteringResult	Result of the CameraControl.startFocusAndMetering(FocusMeteringAction).
ForwardingImageProxy	An ImageProxy which forwards all calls to another ImageProxy.
ImageAnalysis	A use case providing CPU accessible images for an app to perform image analysis on.
ImageAnalysis.Builder	Builder for a ImageAnalysis.
ImageAnalysis.Defaults	Provides a base static default configuration for the ImageAnalysis.
ImageAnalysisConfig	Configuration for an image analysis use case.
ImageAnalysisConfig.Builder	Builder for a ImageAnalysisConfig.
ImageCapture	A use case for taking a picture.
ImageCapture.Builder	Builder for an ImageCapture.
ImageCapture.Defaults	Provides a base static default configuration for the ImageCapture
ImageCapture.Metadata	Holder class for metadata that will be saved with captured images.
ImageCapture.OnImageCapturedCallback	Callback for image capture events.
ImageCapture.OutputFileOptions	Options for saving newly captured image.
ImageCapture.OutputFileOptions.Builder	Builder class for ImageCapture.OutputFileOptions.
ImageCapture.OutputFileResults	Info about the saved image file.
ImageCaptureConfig	Configuration for an image capture use case.
ImageCaptureConfig.Builder	Builder for a ImageCaptureConfig.
ImageCaptureLatencyEstimate	An immutable representation of the estimated duration an image capture will take capturing and processing the current scene according to the scene's lighting condition and/or camera configuration.
ImageFormatConstants	This class used to constant values corresponding to the internal defined image format value used in StreamConfigurationMap.java.
ImageProcessingUtil	Utility class to convert an `Image` from YUV to RGB.
ImageReaderProxys	Different implementations of ImageReaderProxy.
ImmediateSurface	A DeferrableSurface which always returns immediately.
ImmutableImageInfo
LensFacingCameraIdFilter	A filter selects camera id with specified lens facing from a camera id set.
Logger	Handles logging requests inside CameraX.
MetadataImageReader	An ImageReaderProxy which matches the incoming with its ImageInfo.
MeteringPoint	A MeteringPoint is used to specify a region which can then be converted to sensor coordinate system for focus and metering purpose.
MeteringPointFactory	A factory to create a MeteringPoint.
MirrorMode	The mirror mode.
MultiValueSet<C>	A value set implementation that store multiple values in type C.
MutableOptionsBundle	A MutableOptionsBundle is an OptionsBundle which allows for insertion/removal.
OptionsBundle	An immutable implementation of Config.
Preview	A use case that provides a camera preview stream for displaying on-screen.
Preview.Builder	Builder for a Preview.
Preview.Defaults	Provides a base static default configuration for the Preview
PreviewConfig	Configuration for a Preview use case.
PreviewConfig.Builder	Builder for a PreviewConfig.
ResolutionInfo	A ResolutionInfo allows the application to know the resolution information of a specific use case.
RetryPolicy.Builder	A builder class for customizing RetryPolicy behavior.
RetryPolicy.RetryConfig	Represents the outcome of a RetryPolicy decision.
RetryPolicy.RetryConfig.Builder	A builder class for creating and customizing RetryPolicy.RetryConfig objects.
SafeCloseImageReaderProxy	An ImageReaderProxy that wraps another ImageReaderProxy to safely wait until all produced ImageProxy are closed before closing the ImageReaderProxy.
SensorOrientedMeteringPointFactory	A MeteringPointFactory that can create MeteringPoint by sensor oriented x, y , width and height.
SessionConfig	Configurations needed for a capture session.
SessionConfig.Builder	Builder for easy modification/rebuilding of a SessionConfig.
SessionConfig.ValidatingBuilder	Builder for combining multiple instances of SessionConfig.
SettableImageProxy	An ImageProxy which overwrites the ImageInfo.
SingleImageProxyBundle	An ImageProxyBundle that contains a single ImageProxy.
SurfaceCombination	Surface configuration combination
SurfaceConfig	Surface configuration type and size pair
SurfaceOrientedMeteringPointFactory	A MeteringPointFactory that can create MeteringPoint by surface oriented x, y on an area defined by (0, 0) - (width, height).
SurfaceOutput.CameraInputInfo	Camera input information for transformation matrix calculation in SurfaceOutput.
SurfaceOutput.Event	Events of the retrieved from SurfaceOutput.getSurface(Executor, Consumer).
SurfaceRequest	A completable, single-use request of a .
SurfaceRequest.Result	Result of providing a surface to a SurfaceRequest via SurfaceRequest.provideSurface(Surface, Executor, Consumer).
SurfaceRequest.TransformationInfo	Transformation associated the preview output.
SurfaceSizeDefinition	Camera device surface size definition
TorchState	The camera flash torch state.
UseCase	The use case which all other use cases are built on top of.
UseCaseAttachState	Collection of use cases which are attached to a specific camera.
UseCaseGroup	Represents a collection of UseCase.
UseCaseGroup.Builder	A builder for generating UseCaseGroup.
VideoCapture	A use case for taking a video.
VideoCapture.Builder	Builder for a VideoCapture.
VideoCapture.Defaults	Provides a base static default configuration for the VideoCapture
VideoCapture.Metadata	Holder class for metadata that should be saved alongside captured video.
VideoCapture.OutputFileOptions	Options for saving newly captured video.
VideoCapture.OutputFileOptions.Builder	Builder class for VideoCapture.OutputFileOptions.
VideoCapture.OutputFileResults	Info about the saved video file.
VideoCaptureConfig	Config for a video capture use case.
VideoCaptureConfig.Builder	Builder for a VideoCaptureConfig.
ViewPort	The field of view of one or many UseCases.
ViewPort.Builder	Builder for ViewPort.

Enums

BaseCamera.State	The state of a camera within the process.
CameraCaptureFailure.Reason	The capture result has been dropped this frame only due to an error in the framework.
CameraCaptureMetaData.AeState	Auto exposure (AE) state.
CameraCaptureMetaData.AfMode	Auto focus (AF) mode.
CameraCaptureMetaData.AfState	Auto focus (AF) state.
CameraCaptureMetaData.AwbState	Auto white balance (AWB) state.
CameraCaptureMetaData.FlashState	Flash state.
CameraState.ErrorType	Types of errors the camera can encounter.
CameraState.Type	States the camera can be in.
FlashMode	The flash mode options when taking a picture using ImageCapture.
SessionConfig.SessionError
SurfaceConfig.ConfigSize	The Camera2 stream sizes for the surface.
SurfaceConfig.ConfigType	The Camera2 configuration type for the surface.

Annotation Types

AspectRatio.Ratio
CameraEffect.Formats	Bitmask options for the effect buffer formats.
CameraEffect.OutputOptions	Options for how many outputs the effect handles.
CameraEffect.Targets	Bitmask options for the effect targets.
CameraEffect.Transformations	Options for the transformation handled by the effect.
CameraInfo.ImplementationType
CameraSelector.LensFacing	The direction the camera faces relative to device screen.
CameraUnavailableException.Reason
DynamicRange.BitDepth
DynamicRange.DynamicRangeEncoding
ExperimentalAnalyzer	Denotes that the annotated API uses the experimental ImageAnalysis.Analyzer methods which allow additional features like overriding ImageAnalysis configuration and coordinates transformation.
ExperimentalCameraFilter	Denotes that the annotated method uses an experimental API that customizes camera filters to select a specific camera.
ExperimentalCustomizableThreads	Denotes that the annotated method uses an experimental API that swaps the default threading implementation with a user-defined threading implementation.
ExperimentalExposureCompensation	Denotes that the annotated method uses the experimental ExposureCompensation APIs that can control the exposure compensation of the camera.
ExperimentalGetImage	Denotes that the annotated method uses the experimental ImageProxy.getImage() method.
ExperimentalImageCaptureOutputFormat	Denotes that the annotated method uses an experimental path for configuring output format of ImageCapture or related querying in ImageCaptureCapabilities.
ExperimentalLensFacing	Denotes that the annotated API is designed to be used with a lens facing that its behavior hasn't been verified thoroughly.
ExperimentalMirrorMode	Denotes that the annotated API is designed to be experimental for MirrorMode
ExperimentalRetryPolicy	Indicates that the annotated API uses the experimental RetryPolicy feature for CameraX initialization.
ExperimentalUseCaseApi	Denotes that the methods on use cases and use case builders are experimental and may change in a future release
ExperimentalUseCaseGroup	Denotes that the annotated classes and methods uses the experimental feature which provides a grouping mechanism for UseCases.
ExperimentalZeroShutterLag	Denotes that the annotated API uses the experimental zero-shutter lag capture mode in ImageCapture and related querying function in CameraInfo.
FocusMeteringAction.MeteringMode	Focus/Metering mode used to specify which 3A regions is activated for corresponding MeteringPoint.
ImageAnalysis.BackpressureStrategy	How to apply backpressure to the source producing images for analysis.
ImageAnalysis.OutputImageFormat	Supported output image format for image analysis.
ImageCapture.CaptureMode	Capture mode options for ImageCapture.
ImageCapture.FlashMode	The flash mode options when taking a picture using ImageCapture.
ImageCapture.FlashType	The flash type options when flash is required for taking a picture.
ImageCapture.ImageCaptureError	Describes the error that occurred during an image capture operation (such as ImageCapture.takePicture(Executor, ImageCapture.OnImageCapturedCallback)).
ImageCapture.OutputFormat	The output format of the captured image.
ImageOutputConfig.RotationValue	Valid integer rotation values.
ImageProcessor.OutputFormats	Valid output formats.
MirrorMode.Mirror
RetryPolicy.ExecutionState.Status	Defines the status codes for the RetryPolicy.ExecutionState.
SurfaceOutput.Event.EventCode	Possible event codes.
SurfaceRequest.Result.ResultCode	Possible result codes.
TorchState.State
VideoCapture.VideoCaptureError	Describes the error that occurred during video capture operations.
ViewPort.LayoutDirection	LayoutDirection that defines the start and end of the ViewPort.ScaleType.
ViewPort.ScaleType	Scale types used to calculate the crop rect for a UseCase.