PreviewExtender
abstract class PreviewExtender
kotlin.Any | |
↳ | androidx.camera.extensions.PreviewExtender |
Class for using an OEM provided extension on preview.
Summary
Public constructors | |
---|---|
<init>() Class for using an OEM provided extension on preview. |
Public methods | |
---|---|
open Unit |
enableExtension(@NonNull cameraSelector: CameraSelector) Enables the derived image capture extension feature. |
open Boolean |
isExtensionAvailable(@NonNull cameraSelector: CameraSelector) Indicates whether extension function can support with the given |
Public constructors
<init>
PreviewExtender()
Class for using an OEM provided extension on preview.
Public methods
enableExtension
open fun enableExtension(@NonNull cameraSelector: CameraSelector): Unit
Enables the derived image capture extension feature. If the extension can't be applied on any of the cameras specified with the given CameraSelector
, it will be no-ops.
Enabling extensions on Preview
may limit the number of cameras which can be selected when the Preview
is used as a parameter to bindToLifecycle. BindToLifecycle will throw an exception if no cameras are found that support the extension.
Preview extension has dependence on image capture extension. A IMAGE_CAPTURE_EXTENSION_REQUIRED error will be thrown if corresponding image capture extension is not enabled together.
Parameters | |
---|---|
cameraSelector |
CameraSelector: The selector used to determine the camera for which to enable extensions. |
isExtensionAvailable
open fun isExtensionAvailable(@NonNull cameraSelector: CameraSelector): Boolean
Indicates whether extension function can support with the given CameraSelector
.
Parameters | |
---|---|
cameraSelector |
CameraSelector: The selector that determines a camera that will be checked for the availability of extensions. |
Return | |
---|---|
Boolean |
True if the specific extension function is supported for the camera device. |