供应商扩展

CameraX 会提供一个 API,以取用手机制造商为特定手机实现的效果(焦外成像、HDR 及其他功能)。为了支持供应商扩展,设备必须满足以下所有条件:

  • 设备 OEM 为相应效果提供库支持。
  • 当前设备上已安装了 OEM 库。
  • OEM 库报告设备支持扩展。
  • 设备上搭载了库所要求的操作系统版本。

您可以根据以下优先原则启用扩展:如果扩展受设备支持且实际存在于设备上,则启用该扩展,否则对其进行适当降级。

供应商不需要实现所有效果和功能。供应商未实现的功能都将默认采用 CameraX 实现。默认实现会报告相应功能不可用并跳过启用操作。

扩展架构

下图显示了 CameraX 的扩展架构。

图 1:CameraX 扩展架构

扩展与 CameraX 的 Camera2 核心是分开的。如图所示,红色箭头表示用户触发基于扩展的功能(例如 HDR 图片拍摄)时产生的主要数据流。

启用效果以用于图片拍摄和预览

在使用扩展 API 之前,请使用 ExtensionsManager#getInstance(Context) 方法检索 ExtensionsManager 实例。这样,您就可以查询扩展可用性信息。然后检索已启用扩展的 CameraSelector。如在启用 CameraSelector 扩展的情况下调用 bindToLifecycle() 方法,则扩展模式将应用于图片拍摄和预览用例。

如需实现图片拍摄和预览用例的扩展,请参阅以下代码示例:

Kotlin

import androidx.camera.extensions.ExtensionMode
import androidx.camera.extensions.ExtensionsManager

fun onCreate() {
    // Create a camera provider
    val cameraProvider : ProcessCameraProvider = ... // Get the provider instance

    lifecycleScope.launch {
        // Create an extensions manager
        val extensionsManager = ExtensionsManager.getInstance(lifecycleOwner).await()

        // Select the camera
        val cameraSelector = CameraSelector.DEFAULT_BACK_CAMERA

        // Query if extension is available.
        if (extensionsManager.isExtensionAvailable(
                cameraProvider,
                cameraSelector,
                ExtensionMode.BOKEH
            )
        ) {
            // Unbind all use cases before enabling different extension modes.
            cameraProvider.unbindAll()

            // Retrieve extension enabled camera selector
            val bokehCameraSelector = extensionsManager.getExtensionEnabledCameraSelector(
                cameraProvider,
                cameraSelector,
                ExtensionMode.BOKEH
            )

            // Bind image capture and preview use cases with the extension enabled camera selector.
            val imageCapture = ImageCapture.Builder().build()
            val preview = Preview.Builder().build()
            cameraProvider.bindToLifecycle(
                lifecycleOwner,
                bokehCameraSelector,
                imageCapture,
                preview
            )
        }
    }
}

Java

import androidx.camera.extensions.ExtensionMode;
import androidx.camera.extensions.ExtensionsManager;

void onCreate() {
    // Create a camera provider
    ProcessCameraProvider cameraProvider = ... // Get the provider instance

    // Call the getInstance function to retrieve a ListenableFuture object
    ListenableFuture future = ExtensionsManager.getInstance(lifecycleOwner);

    // Obtain the ExtensionsManager instance from the returned ListenableFuture object
    future.addListener(() -> {
        try {
            ExtensionsManager extensionsManager = future.get();

            // Select the camera
            CameraSelector cameraSelector = CameraSelector.DEFAULT_BACK_CAMERA;

            // Query if extension is available.
            if (extensionsManager
                .isExtensionAvailable(cameraProvider, cameraSelector, ExtensionMode.BOKEH)) {
                // Unbind all use cases before enabling different extension modes.
                cameraProvider.unbindAll();

                // Retrieve extension enabled camera selector
                CameraSelector bokehCameraSelector = extensionsManager
                    .getExtensionEnabledCameraSelector(cameraProvider, cameraSelector, ExtensionMode.BOKEH);

                // Bind image capture and preview use cases with the extension enabled camera selector.
                ImageCapture imageCapture = new ImageCapture.Builder().build();
                Preview preview = new Preview.Builder().build();
                cameraProvider.bindToLifecycle(lifecycleOwner, bokehCameraSelector, imageCapture, preview);
            }
        } catch (ExecutionException | InterruptedException e) {
            // This should not happen unless the future is cancelled or the thread is interrupted by
            // applications.
        }
    }, ContextCompact.getMainExecutor(context));
}

停用效果

如需停用供应商扩展,请取消绑定所有用例,然后使用常规相机选择器重新绑定图片拍摄和预览用例。例如,使用 CameraSelector.DEFAULT_BACK_CAMERA 重新绑定到后置摄像头。

其他资源

要详细了解 CameraX,请参阅下面列出的其他资源。

Codelab

  • CameraX 使用入门
  • 代码示例

  • 官方 CameraX 示例应用
  • 旧版 API 移除历史记录

    1.0.0-alpha26 中提供了一组新的扩展 API。开发者只需获取一个已启用扩展的相机选择器,并使用它来绑定用例。以下旧版扩展器类和相关 API 已在 camera-extensions 1.0.0-alpha26 中废弃,并从 1.0.0-alpha28 中移除。

    • AutoImageCaptureExtender
    • AutoPreviewExtender
    • BeautyImageCaptureExtender
    • BeautyPreviewExtender
    • BokehImageCaptureExtender
    • BokehPreviewExtender
    • HdrImageCaptureExtender
    • HdrPreviewExtender
    • NightImageCaptureExtender
    • NightPreviewExtender