LifecycleCameraController

Added in 1.1.0

Kotlin |Java

class LifecycleCameraController : CameraController

kotlin.Any
↳	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(context: Context)`

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

Inherited Constants

From androidx.camera.view.CameraController

`const Int`	`COORDINATE_SYSTEM_VIEW_REFERENCED = 1` This property is deprecated. Use `COORDINATE_SYSTEM_VIEW_REFERENCED` instead.
`const Int`	`IMAGE_ANALYSIS = 2` Bitmask option to enable `ImageAnalysis`.
`const Int`	`IMAGE_CAPTURE = 1` Bitmask option to enable `ImageCapture`.
`const Int`	`TAP_TO_FOCUS_FAILED = 4` The previous tap-to-focus action was failed to complete.
`const Int`	`TAP_TO_FOCUS_FOCUSED = 2` The previous tap-to-focus action was completed successfully and the camera is focused.
`const 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.
`const Int`	`TAP_TO_FOCUS_NOT_STARTED = 0` No tap-to-focus action has been started by the end user.
`const Int`	`TAP_TO_FOCUS_STARTED = 1` A tap-to-focus action has started but not completed.
`const Int`	`VIDEO_CAPTURE = 4` Bitmask option to enable video capture use case.

Inherited functions

From androidx.camera.view.CameraController

`Unit`	`@MainThread clearEffects()` Removes all effects.
`Unit`	`@MainThread clearImageAnalysisAnalyzer()` Removes a previously set analyzer.
`ListenableFuture<Void!>`	`@MainThread enableTorch(torchEnabled: Boolean)` Enable the torch or disable the torch.
`CameraControl?`	`@MainThread getCameraControl()` Gets the `CameraControl` of the currently attached camera.
`CameraInfo?`	`@MainThread getCameraInfo()` Gets the `CameraInfo` of the currently attached camera.
`CameraSelector`	`@MainThread getCameraSelector()` Gets the `CameraSelector`.
`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`.
`ResolutionSelector?`	`@MainThread getImageAnalysisResolutionSelector()` Returns the `ResolutionSelector` for `ImageAnalysis`.
`CameraController.OutputSize?`	`@MainThread getImageAnalysisTargetSize()` This function is deprecated. Use `getImageAnalysisResolutionSelector` instead.
`Int`	`@MainThread getImageCaptureFlashMode()` Gets the flash mode for `ImageCapture`.
`Executor?`	`@MainThread getImageCaptureIoExecutor()` Gets the default executor for `ImageCapture` IO tasks.
`Int`	`@MainThread getImageCaptureMode()` Returns the image capture mode.
`ResolutionSelector?`	`@MainThread getImageCaptureResolutionSelector()` Returns the `ResolutionSelector` for `ImageCapture`.
`CameraController.OutputSize?`	`@MainThread getImageCaptureTargetSize()` This function is deprecated. Use `getImageCaptureResolutionSelector` instead.
`ListenableFuture<Void!>`	`getInitializationFuture()` Gets a `ListenableFuture` that completes when camera initialization completes.
`ResolutionSelector?`	`@MainThread getPreviewResolutionSelector()` Returns the `ResolutionSelector` for `Preview`.
`CameraController.OutputSize?`	`@MainThread getPreviewTargetSize()` This function is deprecated. Use `getPreviewResolutionSelector` instead.
`LiveData<TapToFocusInfo!>`	`@MainThread getTapToFocusInfoState()` Returns a `LiveData` with a `TapToFocusInfo` containing the latest focus state and corresponding tap position.
`LiveData<Int!>`	`@MainThread getTapToFocusState()` This function is deprecated. Use `getTapToFocusInfoState` instead.
`LiveData<Int!>`	`@MainThread getTorchState()` Returns a `LiveData` of current `TorchState`.
`DynamicRange`	`@MainThread getVideoCaptureDynamicRange()` Gets the `DynamicRange` for video capture.
`Int`	`@MainThread getVideoCaptureMirrorMode()` Gets the mirror mode for video capture.
`QualitySelector`	`@MainThread getVideoCaptureQualitySelector()` Returns the `QualitySelector` for `VIDEO_CAPTURE`.
`Range<Int!>`	`@MainThread getVideoCaptureTargetFrameRate()` Gets the target frame rate in frames per second for video capture.
`LiveData<ZoomState!>`	`@MainThread getZoomState()` Returns a `LiveData` of `ZoomState`.
`Boolean`	`@MainThread hasCamera(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.
`Unit`	`@MainThread setCameraSelector(cameraSelector: CameraSelector)` Sets the `CameraSelector`.
`Unit`	`@MainThread setEffects(effects: (Mutable)Set<CameraEffect!>)` Sets `CameraEffect`.
`Unit`	`@MainThread setEnabledUseCases(enabledUseCases: Int)` Enables or disables use cases.
`Unit`	`@MainThread setImageAnalysisAnalyzer( executor: Executor, analyzer: ImageAnalysis.Analyzer )` Sets an analyzer to receive and analyze images.
`Unit`	`@MainThread setImageAnalysisBackgroundExecutor(executor: Executor?)` Sets the executor that will be used for `ImageAnalysis` background tasks.
`Unit`	`@MainThread setImageAnalysisBackpressureStrategy(strategy: Int)` 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.
`Unit`	`@MainThread setImageAnalysisImageQueueDepth(depth: Int)` Sets the image queue depth of `ImageAnalysis`.
`Unit`	`@MainThread setImageAnalysisOutputImageFormat(imageAnalysisOutputImageFormat: Int)` Sets the output image format for `ImageAnalysis`.
`Unit`	`@MainThread setImageAnalysisResolutionSelector( resolutionSelector: ResolutionSelector? )` Sets the `ResolutionSelector` for `ImageAnalysis`.
`Unit`	`@MainThread setImageAnalysisTargetSize(targetSize: CameraController.OutputSize?)` This function is deprecated. Use `setImageAnalysisResolutionSelector` instead.
`Unit`	`@MainThread setImageCaptureFlashMode(flashMode: Int)` Sets the flash mode for `ImageCapture`.
`Unit`	`@MainThread setImageCaptureIoExecutor(executor: Executor?)` Sets the default executor that will be used for `ImageCapture` IO tasks.
`Unit`	`@MainThread setImageCaptureMode(captureMode: Int)` Sets the image capture mode.
`Unit`	`@MainThread setImageCaptureResolutionSelector( resolutionSelector: ResolutionSelector? )` Sets the `ResolutionSelector` for `ImageCapture`.
`Unit`	`@MainThread setImageCaptureTargetSize(targetSize: CameraController.OutputSize?)` This function is deprecated. Use `setImageCaptureResolutionSelector` instead.
`ListenableFuture<Void!>`	`@MainThread setLinearZoom(linearZoom: @FloatRange(from = 0.0, to = 1.0) Float)` Sets current zoom by a linear zoom value ranging from 0f to 1.0f.
`Unit`	`@MainThread setPinchToZoomEnabled(enabled: Boolean)` Enables/disables pinch-to-zoom.
`Unit`	`@MainThread setPreviewResolutionSelector(resolutionSelector: ResolutionSelector?)` Sets the `ResolutionSelector` for `Preview`.
`Unit`	`@MainThread setPreviewTargetSize(targetSize: CameraController.OutputSize?)` This function is deprecated. Use `setPreviewResolutionSelector` instead.
`Unit`	`@MainThread setTapToFocusAutoCancelDuration( duration: @IntRange(from = 0) Long, timeUnit: TimeUnit )` Sets the auto-cancel duration for tap-to-focus events.
`Unit`	`@MainThread setTapToFocusEnabled(enabled: Boolean)` Enables/disables tap-to-focus.
`Unit`	`@MainThread setVideoCaptureDynamicRange(dynamicRange: DynamicRange)` Sets the `DynamicRange` for video capture.
`Unit`	`@MainThread setVideoCaptureMirrorMode(mirrorMode: Int)` Sets the mirror mode for video capture.
`Unit`	`@MainThread setVideoCaptureQualitySelector(qualitySelector: QualitySelector)` Sets the `QualitySelector` for `VIDEO_CAPTURE`.
`Unit`	`@MainThread setVideoCaptureTargetFrameRate(targetFrameRate: Range<Int!>)` Sets the target frame rate range in frames per second for video capture.
`ListenableFuture<Void!>`	`@MainThread setZoomRatio(zoomRatio: Float)` Sets current zoom by ratio.
`Recording`	`@RequiresApi(value = 26) @MainThread startRecording( outputOptions: FileDescriptorOutputOptions, audioConfig: AudioConfig, executor: Executor, listener: Consumer<VideoRecordEvent!> )` Takes a video to a given file descriptor.
`Recording`	`@MainThread startRecording( outputOptions: FileOutputOptions, audioConfig: AudioConfig, executor: Executor, listener: Consumer<VideoRecordEvent!> )` Takes a video to a given file.
`Recording`	`@MainThread startRecording( outputOptions: MediaStoreOutputOptions, audioConfig: AudioConfig, executor: Executor, listener: Consumer<VideoRecordEvent!> )` Takes a video to MediaStore.
`Unit`	`@MainThread takePicture( executor: Executor, callback: ImageCapture.OnImageCapturedCallback )` Captures a new still image for in memory access.
`Unit`	`@MainThread takePicture( outputFileOptions: ImageCapture.OutputFileOptions, executor: Executor, imageSavedCallback: ImageCapture.OnImageSavedCallback )` Captures a new still image and saves to a file along with application specified metadata.

Public constructors

LifecycleCameraController

Added in 1.1.0

LifecycleCameraController(context: Context)

Public functions

bindToLifecycle

Added in 1.1.0

@MainThread
fun bindToLifecycle(lifecycleOwner: LifecycleOwner): Unit

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
fun unbind(): Unit

Clears the previously set LifecycleOwner and stops the camera.

See also
`unbindAll`