package

androidx.camera.core

Interfaces

BaseCameraThe base camera interface.
CameraCaptureResultThe result of a single image capture.
CameraControlAn interface for controlling camera's zoom, focus and metering across all use cases.
CameraControlInternalThe CameraControlInternal Interface.
CameraControlInternal.ControlUpdateListenerListener called when CameraControlInternal need to notify event.
CameraDeviceConfigConfiguration containing options for configuring a Camera device.
CameraDeviceConfig.Builder<B>Builder for a CameraDeviceConfig.
CameraDeviceSurfaceManagerCamera device manager to provide the guaranteed supported stream capabilities related info for all camera devices
CameraFactoryThe factory class that creates BaseCamera instances.
CameraIdFilterA filter selects certain type of camera id from a camera id set.
CameraInfoAn interface for retrieving camera information.
CameraInfoInternalAn interface for retrieving camera information.
CameraX.ErrorListenerListener called whenever an error condition occurs within CameraX.
CaptureBundleA interface to return an ordered collection of CaptureStage.
CaptureConfig.OptionUnpackerInterface for unpacking a configuration into a CaptureConfig.Builder
CaptureProcessorA processing step of the image capture pipeline.
CaptureStageA CaptureConfig with an identifier.
ConfigA Configuration is a collection of options and values.
Config.ExtendableBuilderExtendable builders are used to add externally defined options to a configuration.
Config.OptionMatcherA callback for retrieving results of a Config.Option search.
ConfigProvider<C>A class which provides a Config object.
DeferrableSurface.OnSurfaceDetachedListenerThe listener to be called when surface is detached totally.
FocusMeteringAction.OnAutoFocusListenerListener for receiving auto-focus completion event.
ImageAnalysis.AnalyzerInterface for analyzing images.
ImageCapture.OnImageSavedListenerListener containing callbacks for image file I/O events.
ImageInfoMetadata for an image.
ImageInfoProcessorA processing step that updates the necessary CaptureStage based on the current ImageInfo.
ImageOutputConfigConfiguration containing options for configuring the output image data of a pipeline.
ImageOutputConfig.Builder<B>Builder for a ImageOutputConfig.
ImageProxyAn image proxy which has an analogous interface as .
ImageProxy.PlaneProxyA plane proxy which has an analogous interface as .
ImageProxyBundleA set of ImageProxy which are mapped an identifier.
ImageReaderProxyAn image reader proxy which has an analogous interface as .
ImageReaderProxy.OnImageAvailableListenerA listener for newly available images.
MutableConfigMutableConfig 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.OnPreviewOutputUpdateListenerA listener of Preview.PreviewOutput.
Preview.PreviewSurfaceCallbackA callback to access the Preview Surface.
SessionConfig.ErrorListenerCallback for errors that occur when accessing the session config.
SessionConfig.OptionUnpackerInterface for unpacking a configuration into a SessionConfig.Builder

TODO(b/120949879): This will likely be removed once SessionConfig is refactored to remove camera2 dependencies.

TargetConfig<T>Configuration containing options used to identify the target class and object being configured.
TargetConfig.Builder<T, B>Builder for a TargetConfig.
UseCase.EventListenerListener called when a UseCase transitions between bind/unbind states.
UseCase.StateChangeListenerListener called 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.
UseCaseConfigFactoryA Repository for generating use case configurations.
UseCaseEventConfigConfiguration containing options pertaining to EventListener object.
UseCaseEventConfig.Builder<B>Builder for a UseCaseEventConfig.
VideoCapture.OnVideoSavedListenerListener containing callbacks for video file I/O events.

Classes

AppConfigConfiguration for adding implementation and user-specific behavior to CameraX.
AppConfig.BuilderA builder for generating AppConfig objects.
CameraCaptureCallbackA callback object for tracking the progress of a capture request submitted to the camera device.
CameraCaptureCallbacksDifferent implementations of CameraCaptureCallback.
CameraCaptureCallbacks.ComboCameraCaptureCallbackA CameraCaptureCallback which contains a list of CameraCaptureCallback and will propagate received callback to the list.
CameraCaptureFailureA report of failed capture for a single image capture.
CameraCaptureMetaDataThis class defines the enumeration constants used for querying the camera capture mode and results.
CameraCaptureResult.EmptyCameraCaptureResultAn implementation of CameraCaptureResult which always return default results.
CameraCaptureResultsUtility functionality for CameraCaptureResult.
CameraCaptureSessionStateCallbacksDifferent implementations of .
CameraDeviceStateCallbacksDifferent implementations of .
CameraIdFilterSetA CameraIdFilter which holds multiple CameraIdFilter and filters camera ids with all of them.
CameraOrientationUtilContains utility methods related to camera orientation.
CameraRepositoryA collection of BaseCamera instances.
CameraXMain interface for accessing CameraX library.
CameraXThreadsStatic tag for creating CameraX threads.
CaptureConfigConfigurations needed for a capture request.
CaptureConfig.BuilderBuilder for easy modification/rebuilding of a CaptureConfig.
CaptureStage.DefaultCaptureStageA capture stage which contains no additional implementation options
Config.Option<T>An Config.Option is used to set and retrieve values for settings defined in a Config.
DeferrableSurfaceA reference to a whose creation can be deferred to a later time.
DeferrableSurfacesUtility functions for manipulating DeferrableSurface.
DevicePropertiesContainer of the device properties.
DisplayOrientedMeteringPointFactoryA MeteringPointFactory that can create MeteringPoint by display oriented x, y.
ErrorHandlerHandler for sending and receiving error messages.
ExifUtility class for modifying metadata on JPEG files.
ExtendableUseCaseConfigFactoryA UseCaseConfigFactory that uses ConfigProviders to provide configurations.
FocusMeteringActionA configuration used to trigger a focus and/or metering action.
FocusMeteringAction.BuilderThe builder used to create the FocusMeteringAction.
ImageAnalysisA use case providing CPU accessible images for an app to perform image analysis on.
ImageAnalysis.DefaultsProvides a base static default configuration for the ImageAnalysis

These values may be overridden by the implementation.

ImageAnalysisConfigConfiguration for an image analysis use case.
ImageAnalysisConfig.BuilderBuilder for a ImageAnalysisConfig.
ImageCaptureA use case for taking a picture.
ImageCapture.DefaultsProvides a base static default configuration for the ImageCapture

These values may be overridden by the implementation.

ImageCapture.MetadataHolder class for metadata that will be saved with captured images.
ImageCapture.OnImageCapturedListenerListener called when an image capture has completed.
ImageCaptureConfigConfiguration for an image capture use case.
ImageCaptureConfig.BuilderBuilder for a ImageCaptureConfig.
ImageFormatConstantsThis class used to constant values corresponding to the internal defined image format value used in StreamConfigurationMap.java.
ImageReaderProxysDifferent implementations of ImageReaderProxy.
ImmediateSurfaceA DeferrableSurface which always returns immediately.
LensFacingCameraIdFilterA filter selects camera id with specified lens facing from a camera id set.
MeteringPointA MeteringPoint used to specify a region in sensor coordinates for focusing and metering Purpose.
MeteringPointFactoryA Factory to create a MeteringPoint.
MultiValueSet<C>A value set implementation that store multiple values in type C.
MutableOptionsBundleA MutableOptionsBundle is an OptionsBundle which allows for insertion/removal.
OptionsBundleAn immutable implementation of Config.
PreviewA use case that provides a camera preview stream for displaying on-screen.
Preview.DefaultsProvides a base static default configuration for the Preview

These values may be overridden by the implementation.

Preview.PreviewOutputA bundle containing a SurfaceTexture and properties needed to display a Preview.
PreviewConfigConfiguration for a Preview use case.
PreviewConfig.BuilderBuilder for a PreviewConfig.
SensorOrientedMeteringPointFactoryA MeteringPointFactory that can create MeteringPoint by sensor oriented x, y , width and height.
SessionConfigConfigurations needed for a capture session.
SessionConfig.BuilderBuilder for easy modification/rebuilding of a SessionConfig.
SessionConfig.ValidatingBuilderBuilder for combining multiple instances of SessionConfig.
SingleImageProxyBundleAn ImageProxyBundle that contains a single ImageProxy.
SurfaceCombinationSurface configuration combination

android.hardware.camera2.CameraDevice defines the default guaranteed stream combinations for different hardware level devices.

SurfaceConfigSurface configuration type and size pair

android.hardware.camera2.CameraDevice defines the default guaranteed stream combinations for different hardware level devices.

SurfaceSizeDefinitionCamera device surface size definition

android.hardware.camera2.CameraDevice defines the default guaranteed stream combinations for different hardware level devices.

UseCaseThe use case which all other use cases are built on top of.
UseCaseAttachStateCollection of use cases which are attached to a specific camera.
UseCaseGroupA collection of UseCase.
VideoCaptureA use case for taking a video.
VideoCapture.DefaultsProvides a base static default configuration for the VideoCapture

These values may be overridden by the implementation.

VideoCapture.MetadataHolder class for metadata that should be saved alongside captured video.
VideoCaptureConfigConfig for a video capture use case.
VideoCaptureConfig.BuilderBuilder for a VideoCaptureConfig.

Enums

AspectRatioThe aspect ratio of the use case.
BaseCamera.StateThe state of a camera within the process.
CameraCaptureFailure.ReasonThe capture result has been dropped this frame only due to an error in the framework.
CameraCaptureMetaData.AeStateAuto exposure (AE) state.
CameraCaptureMetaData.AfModeAuto focus (AF) mode.
CameraCaptureMetaData.AfStateAuto focus (AF) state.
CameraCaptureMetaData.AwbStateAuto white balance (AWB) state.
CameraCaptureMetaData.FlashStateFlash state.
CameraX.ErrorCodeThe types of error states that can occur.
CameraX.LensFacingThe direction the camera faces relative to device screen.
FlashModeThe flash mode options when taking a picture using ImageCapture.
FocusMeteringAction.MeteringModeFocus/Metering mode used to specify which 3A regions is activated for corresponding MeteringPoint.
ImageAnalysis.ImageReaderModeThe different ways that the image sent to the analyzer is acquired from the underlying .
ImageCapture.CaptureModeCapture mode options for ImageCapture.
ImageCapture.ImageCaptureErrorDescribes the error that occurred during an image capture operation (such as ImageCapture.takePicture(Executor, ImageCapture.OnImageCapturedListener)).
Preview.UseCaseErrorDescribes the error that occurred during preview operation.
SessionConfig.SessionError
SurfaceConfig.ConfigSizeThe Camera2 stream sizes for the surface.
SurfaceConfig.ConfigTypeThe Camera2 configuration type for the surface.
VideoCapture.VideoCaptureErrorDescribes the error that occurred during video capture operations.

Annotation Types

ImageOutputConfig.RotationValueValid integer rotation values.