Summary: Inherited Constants | Ctors | Methods | Inherited Methods

LifecycleCameraController

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

Inherited constants

From class androidx.camera.view.CameraController

`int`	`IMAGE_ANALYSIS` Bitmask option to enable `ImageAnalysis`.
`int`	`IMAGE_CAPTURE` Bitmask option to enable `ImageCapture`.
`int`	`VIDEO_CAPTURE` Bitmask option to enable video capture use case.

Public constructors
`LifecycleCameraController(Context context)`

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

Inherited methods

From class


        
          androidx.camera.view.CameraController

`void`	`clearImageAnalysisAnalyzer()` Removes a previously set analyzer.
`ListenableFuture<Void>`	`enableTorch(boolean torchEnabled)` Enable the torch or disable the torch.
`CameraInfo`	`getCameraInfo()` Gets the `CameraInfo` of the currently attached camera.
`CameraSelector`	`getCameraSelector()` Gets the `CameraSelector`.
`int`	`getImageAnalysisBackpressureStrategy()` Returns the mode with which images are acquired.
`int`	`getImageAnalysisImageQueueDepth()` Gets the image queue depth of `ImageAnalysis`.
`int`	`getImageCaptureFlashMode()` Gets the flash mode for `ImageCapture`.
`ListenableFuture<Void>`	`getInitializationFuture()` Gets a `ListenableFuture` that completes when camera initialization completes.
`LiveData<Integer>`	`getTorchState()` Returns a `LiveData` of current `TorchState`.
`LiveData<ZoomState>`	`getZoomState()` Returns a `LiveData` of `ZoomState`.
`boolean`	`hasCamera(CameraSelector cameraSelector)` Checks if the given `CameraSelector` can be resolved to a camera.
`boolean`	`isImageAnalysisEnabled()` Checks if `ImageAnalysis` is enabled.
`boolean`	`isImageCaptureEnabled()` Checks if `ImageCapture` is enabled.
`boolean`	`isPinchToZoomEnabled()` Returns whether pinch-to-zoom is enabled.
`boolean`	`isRecording()` Returns whether there is a in progress video recording.
`boolean`	`isTapToFocusEnabled()` Returns whether tap-to-focus is enabled.
`boolean`	`isVideoCaptureEnabled()` Checks if video capture is enabled.
`void`	`setCameraSelector(CameraSelector cameraSelector)` Sets the `CameraSelector`.
`void`	`setEnabledUseCases(int enabledUseCases)` Enables or disables use cases.
`void`	`setImageAnalysisAnalyzer(Executor executor, ImageAnalysis.Analyzer analyzer)` Sets an analyzer to receive and analyze images.
`void`	`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`	`setImageAnalysisImageQueueDepth(int depth)` Sets the image queue depth of `ImageAnalysis`.
`void`	`setImageCaptureFlashMode(int flashMode)` Sets the flash mode for `ImageCapture`.
`ListenableFuture<Void>`	`setLinearZoom(float linearZoom)` Sets current zoom by a linear zoom value ranging from 0f to 1.0f.
`void`	`setPinchToZoomEnabled(boolean enabled)` Enables/disables pinch-to-zoom.
`void`	`setTapToFocusEnabled(boolean enabled)` Enables/disables tap-to-focus.
`ListenableFuture<Void>`	`setZoomRatio(float zoomRatio)` Sets current zoom by ratio.
`void`	`startRecording(OutputFileOptions outputFileOptions, Executor executor, OnVideoSavedCallback callback)` Takes a video and calls the OnVideoSavedCallback when done.
`void`	`stopRecording()` Stops a in progress video recording.
`void`	`takePicture(ImageCapture.OutputFileOptions outputFileOptions, Executor executor, ImageCapture.OnImageSavedCallback imageSavedCallback)` Captures a new still image and saves to a file along with application specified metadata.
`void`	`takePicture(Executor executor, ImageCapture.OnImageCapturedCallback callback)` Captures a new still image for in memory access.

From class


        
          java.lang.Object

`Object`	`clone()`
`boolean`	`equals(Object arg0)`
`void`	`finalize()`
`final Class<?>`	`getClass()`
`int`	`hashCode()`
`final void`	`notify()`
`final void`	`notifyAll()`
`String`	`toString()`
`final void`	`wait(long arg0, int arg1)`
`final void`	`wait(long arg0)`
`final void`	`wait()`

Public constructors

LifecycleCameraController

public LifecycleCameraController (Context context)

Parameters
`context`	`Context`

Public methods

bindToLifecycle

public void bindToLifecycle (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.

Parameters
`lifecycleOwner`	`LifecycleOwner`

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

See also:

ProcessCameraProvider.bindToLifecycle(LifecycleOwner, CameraSelector, UseCase...)

unbind

public void unbind ()

Clears the previously set LifecycleOwner and stops the camera.

See also:

ProcessCameraProvider.unbindAll()