LifecycleCameraController

Added in 1.1.0

Kotlin |Java

public final class LifecycleCameraController extends CameraController

java.lang.Object
↳	androidx.camera.view.CameraController
	↳	androidx.camera.view.LifecycleCameraController

A controller that provides most of the CameraX features.

This a high level controller that provides most of the CameraX core features in a single class. It handles camera initialization, creates and configures UseCases, and bind them to a LifecycleOwner when ready. It also listens to device motion sensor and set the target rotation for the use cases.

Code sample:

    // Setup.
    CameraController controller = new LifecycleCameraController(context);
    controller.bindToLifecycle(lifecycleOwner);
    PreviewView previewView = findViewById(R.id.preview_view);
    previewView.setController(controller);

    // Use case features
    controller.takePicture(...);

    // Camera control features
    controller.setZoomRatio(.5F);

Summary

Public constructors
`LifecycleCameraController(@NonNull Context context)`

Public methods
`void`	`@MainThread bindToLifecycle(@NonNull LifecycleOwner lifecycleOwner)` Sets the `LifecycleOwner` to be bound with the controller.
`void`	`@MainThread unbind()` Clears the previously set `LifecycleOwner` and stops the camera.

Inherited Constants

From androidx.camera.view.CameraController

`static final int`	`COORDINATE_SYSTEM_VIEW_REFERENCED = 1` This field is deprecated. Use `COORDINATE_SYSTEM_VIEW_REFERENCED` instead.
`static final int`	`IMAGE_ANALYSIS = 2` Bitmask option to enable `ImageAnalysis`.
`static final int`	`IMAGE_CAPTURE = 1` Bitmask option to enable `ImageCapture`.
`static final int`	`TAP_TO_FOCUS_FAILED = 4` The previous tap-to-focus action was failed to complete.
`static final int`	`TAP_TO_FOCUS_FOCUSED = 2` The previous tap-to-focus action was completed successfully and the camera is focused.
`static final int`	`TAP_TO_FOCUS_NOT_FOCUSED = 3` The previous tap-to-focus action was completed successfully but the camera is still unfocused, similar to the `CONTROL_AF_STATE_NOT_FOCUSED_LOCKED` state.
`static final int`	`TAP_TO_FOCUS_NOT_STARTED = 0` No tap-to-focus action has been started by the end user.
`static final int`	`TAP_TO_FOCUS_STARTED = 1` A tap-to-focus action has started but not completed.
`static final int`	`VIDEO_CAPTURE = 4` Bitmask option to enable video capture use case.

Inherited methods

From androidx.camera.view.CameraController

`void`	`@MainThread clearEffects()` Removes all effects.
`void`	`@MainThread clearImageAnalysisAnalyzer()` Removes a previously set analyzer.
`@NonNull ListenableFuture<Void>`	`@MainThread enableTorch(boolean torchEnabled)` Enable the torch or disable the torch.
`@Nullable CameraControl`	`@MainThread getCameraControl()` Gets the `CameraControl` of the currently attached camera.
`@Nullable CameraInfo`	`@MainThread getCameraInfo()` Gets the `CameraInfo` of the currently attached camera.
`@NonNull CameraSelector`	`@MainThread getCameraSelector()` Gets the `CameraSelector`.
`@Nullable Executor`	`@MainThread getImageAnalysisBackgroundExecutor()` Gets the default executor for `ImageAnalysis` background tasks.
`int`	`@MainThread getImageAnalysisBackpressureStrategy()` Returns the mode with which images are acquired.
`int`	`@MainThread getImageAnalysisImageQueueDepth()` Gets the image queue depth of `ImageAnalysis`.
`int`	`@MainThread getImageAnalysisOutputImageFormat()` Gets the output image format for `ImageAnalysis`.
`@Nullable ResolutionSelector`	`@MainThread getImageAnalysisResolutionSelector()` Returns the `ResolutionSelector` for `ImageAnalysis`.
`@Nullable CameraController.OutputSize`	`@MainThread getImageAnalysisTargetSize()` This method is deprecated. Use `getImageAnalysisResolutionSelector` instead.
`int`	`@MainThread getImageCaptureFlashMode()` Gets the flash mode for `ImageCapture`.
`@Nullable Executor`	`@MainThread getImageCaptureIoExecutor()` Gets the default executor for `ImageCapture` IO tasks.
`int`	`@MainThread getImageCaptureMode()` Returns the image capture mode.
`@Nullable ResolutionSelector`	`@MainThread getImageCaptureResolutionSelector()` Returns the `ResolutionSelector` for `ImageCapture`.
`@Nullable CameraController.OutputSize`	`@MainThread getImageCaptureTargetSize()` This method is deprecated. Use `getImageCaptureResolutionSelector` instead.
`@NonNull ListenableFuture<Void>`	`getInitializationFuture()` Gets a `ListenableFuture` that completes when camera initialization completes.
`@Nullable ResolutionSelector`	`@MainThread getPreviewResolutionSelector()` Returns the `ResolutionSelector` for `Preview`.
`@Nullable CameraController.OutputSize`	`@MainThread getPreviewTargetSize()` This method is deprecated. Use `getPreviewResolutionSelector` instead.
`@NonNull LiveData<Integer>`	`@MainThread getTapToFocusState()` Returns a `LiveData` with the latest tap-to-focus state.
`@NonNull LiveData<Integer>`	`@MainThread getTorchState()` Returns a `LiveData` of current `TorchState`.
`@NonNull DynamicRange`	`@MainThread getVideoCaptureDynamicRange()` Gets the `DynamicRange` for video capture.
`int`	`@MainThread getVideoCaptureMirrorMode()` Gets the mirror mode for video capture.
`@NonNull QualitySelector`	`@MainThread getVideoCaptureQualitySelector()` Returns the `QualitySelector` for `VIDEO_CAPTURE`.
`@NonNull Range<Integer>`	`@MainThread getVideoCaptureTargetFrameRate()` Gets the target frame rate in frames per second for video capture.
`@NonNull LiveData<ZoomState>`	`@MainThread getZoomState()` Returns a `LiveData` of `ZoomState`.
`boolean`	`@MainThread hasCamera(@NonNull CameraSelector cameraSelector)` Checks if the given `CameraSelector` can be resolved to a camera.
`boolean`	`@MainThread isImageAnalysisEnabled()` Checks if `ImageAnalysis` is enabled.
`boolean`	`@MainThread isImageCaptureEnabled()` Checks if `ImageCapture` is enabled.
`boolean`	`@MainThread isPinchToZoomEnabled()` Returns whether pinch-to-zoom is enabled.
`boolean`	`@MainThread isRecording()` Returns whether there is an in-progress video recording.
`boolean`	`@MainThread isTapToFocusEnabled()` Returns whether tap-to-focus is enabled.
`boolean`	`@MainThread isVideoCaptureEnabled()` Checks if video capture is enabled.
`void`	`@MainThread setCameraSelector(@NonNull CameraSelector cameraSelector)` Sets the `CameraSelector`.
`void`	`@MainThread setEffects(@NonNull Set<CameraEffect> effects)` Sets `CameraEffect`.
`void`	`@MainThread setEnabledUseCases(int enabledUseCases)` Enables or disables use cases.
`void`	`@MainThread setImageAnalysisAnalyzer( @NonNull Executor executor, @NonNull ImageAnalysis.Analyzer analyzer )` Sets an analyzer to receive and analyze images.
`void`	`@MainThread setImageAnalysisBackgroundExecutor(@Nullable Executor executor)` Sets the executor that will be used for `ImageAnalysis` background tasks.
`void`	`@MainThread setImageAnalysisBackpressureStrategy(int strategy)` Sets the backpressure strategy to apply to the image producer to deal with scenarios where images may be produced faster than they can be analyzed.
`void`	`@MainThread setImageAnalysisImageQueueDepth(int depth)` Sets the image queue depth of `ImageAnalysis`.
`void`	`@MainThread setImageAnalysisOutputImageFormat(int imageAnalysisOutputImageFormat)` Sets the output image format for `ImageAnalysis`.
`void`	`@MainThread setImageAnalysisResolutionSelector( @Nullable ResolutionSelector resolutionSelector )` Sets the `ResolutionSelector` for `ImageAnalysis`.
`void`	`@MainThread setImageAnalysisTargetSize( @Nullable CameraController.OutputSize targetSize )` This method is deprecated. Use `setImageAnalysisResolutionSelector` instead.
`void`	`@MainThread setImageCaptureFlashMode(int flashMode)` Sets the flash mode for `ImageCapture`.
`void`	`@MainThread setImageCaptureIoExecutor(@Nullable Executor executor)` Sets the default executor that will be used for `ImageCapture` IO tasks.
`void`	`@MainThread setImageCaptureMode(int captureMode)` Sets the image capture mode.
`void`	`@MainThread setImageCaptureResolutionSelector( @Nullable ResolutionSelector resolutionSelector )` Sets the `ResolutionSelector` for `ImageCapture`.
`void`	`@MainThread setImageCaptureTargetSize( @Nullable CameraController.OutputSize targetSize )` This method is deprecated. Use `setImageCaptureResolutionSelector` instead.
`@NonNull ListenableFuture<Void>`	`@MainThread setLinearZoom(@FloatRange(from = 0.0, to = 1.0) float linearZoom)` Sets current zoom by a linear zoom value ranging from 0f to 1.0f.
`void`	`@MainThread setPinchToZoomEnabled(boolean enabled)` Enables/disables pinch-to-zoom.
`void`	`@MainThread setPreviewResolutionSelector( @Nullable ResolutionSelector resolutionSelector )` Sets the `ResolutionSelector` for `Preview`.
`void`	`@MainThread setPreviewTargetSize(@Nullable CameraController.OutputSize targetSize)` This method is deprecated. Use `setPreviewResolutionSelector` instead.
`void`	`@MainThread setTapToFocusEnabled(boolean enabled)` Enables/disables tap-to-focus.
`void`	`@MainThread setVideoCaptureDynamicRange(@NonNull DynamicRange dynamicRange)` Sets the `DynamicRange` for video capture.
`void`	`@MainThread setVideoCaptureMirrorMode(int mirrorMode)` Sets the mirror mode for video capture.
`void`	`@MainThread setVideoCaptureQualitySelector(@NonNull QualitySelector qualitySelector)` Sets the `QualitySelector` for `VIDEO_CAPTURE`.
`void`	`@MainThread setVideoCaptureTargetFrameRate(@NonNull Range<Integer> targetFrameRate)` Sets the target frame rate range in frames per second for video capture.
`@NonNull ListenableFuture<Void>`	`@MainThread setZoomRatio(float zoomRatio)` Sets current zoom by ratio.
`@NonNull Recording`	`@RequiresApi(value = 26) @MainThread startRecording( @NonNull FileDescriptorOutputOptions outputOptions, @NonNull AudioConfig audioConfig, @NonNull Executor executor, @NonNull Consumer<VideoRecordEvent> listener )` Takes a video to a given file descriptor.
`@NonNull Recording`	`@MainThread startRecording( @NonNull FileOutputOptions outputOptions, @NonNull AudioConfig audioConfig, @NonNull Executor executor, @NonNull Consumer<VideoRecordEvent> listener )` Takes a video to a given file.
`@NonNull Recording`	`@MainThread startRecording( @NonNull MediaStoreOutputOptions outputOptions, @NonNull AudioConfig audioConfig, @NonNull Executor executor, @NonNull Consumer<VideoRecordEvent> listener )` Takes a video to MediaStore.
`void`	`@MainThread takePicture( @NonNull Executor executor, @NonNull ImageCapture.OnImageCapturedCallback callback )` Captures a new still image for in memory access.
`void`	`@MainThread takePicture( @NonNull ImageCapture.OutputFileOptions outputFileOptions, @NonNull Executor executor, @NonNull ImageCapture.OnImageSavedCallback imageSavedCallback )` Captures a new still image and saves to a file along with application specified metadata.

Public constructors

LifecycleCameraController

Added in 1.1.0

public LifecycleCameraController(@NonNull Context context)

Public methods

bindToLifecycle

Added in 1.1.0

@MainThread
public void bindToLifecycle(@NonNull LifecycleOwner lifecycleOwner)

Sets the LifecycleOwner to be bound with the controller.

The state of the lifecycle will determine when the cameras are open, started, stopped and closed. When the LifecycleOwner's state is start or greater, the controller receives camera data. It stops once the LifecycleOwner is destroyed.

Throws
`java.lang.IllegalStateException`	If the provided camera selector is unable to resolve a camera to be used for the given use cases.

See also
`ProcessCameraProvider`

unbind

Added in 1.1.0

@MainThread
public void unbind()

Clears the previously set LifecycleOwner and stops the camera.

See also
`unbindAll`