Interfejs API rozszerzeń CameraX

CameraX zapewnia interfejs API rozszerzeń umożliwiający dostęp do rozszerzeń, które producenci urządzeń wdrożyli na różnych urządzeniach z Androidem. Listę obsługiwanych trybów rozszerzeń znajdziesz w sekcji Rozszerzenia aparatu.

Listę urządzeń obsługujących rozszerzenia znajdziesz w sekcji Obsługiwane urządzenia.

Architektura rozszerzeń

Ilustracja poniżej przedstawia architekturę rozszerzeń aparatu.

Rysunek 1. Architektura rozszerzeń aparatu

Aplikacja CameraX może korzystać z rozszerzeń przy użyciu interfejsu CameraX Extensions API. Interfejs CameraX Extensions API zarządza wysyłaniem zapytań o dostępne rozszerzenia, konfigurowaniem sesji kamery rozszerzenia i komunikacją z biblioteką OEM rozszerzeń aparatu. Pozwoli to aplikacji na korzystanie z funkcji takich jak tryb nocny, HDR, Auto, Bokeh i Retusz twarzy.

Włącz rozszerzenie do przechwytywania obrazu i podglądu

Zanim skorzystasz z interfejsu API rozszerzeń, pobierz instancję ExtensionsManager za pomocą metody ExtensionsManager#getInstanceAsync(Context, CameraProvider). Umożliwi Ci to wysyłanie zapytań o informacje o dostępności rozszerzenia. Następnie pobierz rozszerzenie włączone CameraSelector. Tryb rozszerzenia będzie stosowany do przechwytywania obrazu i wyświetlania podglądu podczas wywoływania metody bindToLifecycle() z włączonym rozszerzeniem CameraSelector.

Aby wdrożyć rozszerzenie do przechwytywania obrazu i wyświetlania podglądu, zapoznaj się z tym przykładowym kodem:

Kotlin

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

override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)

    val lifecycleOwner = this

    val cameraProviderFuture = ProcessCameraProvider.getInstance(applicationContext)
    cameraProviderFuture.addListener({
        // Obtain an instance of a process camera provider
        // The camera provider provides access to the set of cameras associated with the device.
        // The camera obtained from the provider will be bound to the activity lifecycle.
        val cameraProvider = cameraProviderFuture.get()

        val extensionsManagerFuture =
            ExtensionsManager.getInstanceAsync(applicationContext, cameraProvider)
        extensionsManagerFuture.addListener({
            // Obtain an instance of the extensions manager
            // The extensions manager enables a camera to use extension capabilities available on
            // the device.
            val extensionsManager = extensionsManagerFuture.get()

            // Select the camera
            val cameraSelector = CameraSelector.DEFAULT_BACK_CAMERA

            // Query if extension is available.
            // Not all devices will support extensions or might only support a subset of
            // extensions.
            if (extensionsManager.isExtensionAvailable(cameraSelector, ExtensionMode.NIGHT)) {
                // Unbind all use cases before enabling different extension modes.
                try {
                    cameraProvider.unbindAll()

                    // Retrieve a night extension enabled camera selector
                    val nightCameraSelector =
                        extensionsManager.getExtensionEnabledCameraSelector(
                            cameraSelector,
                            ExtensionMode.NIGHT
                        )

                    // Bind image capture and preview use cases with the extension enabled camera
                    // selector.
                    val imageCapture = ImageCapture.Builder().build()
                    val preview = Preview.Builder().build()
                    // Connect the preview to receive the surface the camera outputs the frames
                    // to. This will allow displaying the camera frames in either a TextureView
                    // or SurfaceView. The SurfaceProvider can be obtained from the PreviewView.
                    preview.setSurfaceProvider(surfaceProvider)

                    // Returns an instance of the camera bound to the lifecycle
                    // Use this camera object to control various operations with the camera
                    // Example: flash, zoom, focus metering etc.
                    val camera = cameraProvider.bindToLifecycle(
                        lifecycleOwner,
                        nightCameraSelector,
                        imageCapture,
                        preview
                    )
                } catch (e: Exception) {
                    Log.e(TAG, "Use case binding failed", e)
                }
            }
        }, ContextCompat.getMainExecutor(this))
    }, ContextCompat.getMainExecutor(this))
}

Java

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

@Override
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

    final LifecycleOwner lifecycleOwner = this;

    final ListenableFuture cameraProviderFuture =
            ProcessCameraProvider.getInstance(getApplicationContext());

    cameraProviderFuture.addListener(() -> {
      try {
          // Obtain an instance of a process camera provider
          // The camera provider provides access to the set of cameras associated with the
          // device. The camera obtained from the provider will be bound to the activity
          // lifecycle.
          final ProcessCameraProvider cameraProvider = cameraProviderFuture.get();

          final ListenableFuture extensionsManagerFuture =
                  ExtensionsManager.getInstanceAsync(getApplicationContext(), cameraProvider);
          extensionsManagerFuture.addListener(() -> {
              // Obtain an instance of the extensions manager
              // The extensions manager enables a camera to use extension capabilities available
              // on the device.
              try {
                  final ExtensionsManager extensionsManager = extensionsManagerFuture.get();

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

                  // Query if extension is available.
                  // Not all devices will support extensions or might only support a subset of
                  // extensions.
                  if (extensionsManager.isExtensionAvailable(
                          cameraSelector,
                          ExtensionMode.NIGHT
                  )) {
                      // Unbind all use cases before enabling different extension modes.
                      cameraProvider.unbindAll();

                      // Retrieve extension enabled camera selector
                      final CameraSelector nightCameraSelector = extensionsManager
                              .getExtensionEnabledCameraSelector(cameraSelector, ExtensionMode.NIGHT);

                      // Bind image capture and preview use cases with the extension enabled camera
                      // selector.
                      final ImageCapture imageCapture = new ImageCapture.Builder().build();
                      final Preview preview = new Preview.Builder().build();
                      // Connect the preview to receive the surface the camera outputs the frames
                      // to. This will allow displaying the camera frames in either a TextureView
                      // or SurfaceView. The SurfaceProvider can be obtained from the PreviewView.
                      preview.setSurfaceProvider(surfaceProvider);

                      cameraProvider.bindToLifecycle(
                              lifecycleOwner,
                              nightCameraSelector,
                              imageCapture,
                              preview
                      );
                  }
              } catch (ExecutionException | InterruptedException e) {
                  throw new RuntimeException(e);
              }
          }, ContextCompat.getMainExecutor(this));

      } catch (ExecutionException | InterruptedException e) {
          throw new RuntimeException(e);
      }

  }, ContextCompat.getMainExecutor(this));
}

Wyłącz rozszerzenie

Aby wyłączyć rozszerzenia dostawców, usuń powiązanie wszystkich przypadków użycia i ponownie powiąż przechwytywanie obrazu oraz wyświetl podgląd przypadków użycia, używając normalnego selektora aparatu. Możesz na przykład ponownie powiązać go z tylnym aparatem za pomocą polecenia CameraSelector.DEFAULT_BACK_CAMERA.

Zależności

Interfejs CameraX Extensions API został zaimplementowany w bibliotece camera-extensions. Rozszerzenia zależą od modułów podstawowych CameraX (core, camera2, lifecycle).

Odlotowy

dependencies {
  def camerax_version = "1.2.0-rc01"
  implementation "androidx.camera:camera-core:${camerax_version}"
  implementation "androidx.camera:camera-camera2:${camerax_version}"
  implementation "androidx.camera:camera-lifecycle:${camerax_version}"
  //the CameraX Extensions library
  implementation "androidx.camera:camera-extensions:${camerax_version}"
    ...
}

Kotlin

dependencies {
  val camerax_version = "1.2.0-rc01"
  implementation("androidx.camera:camera-core:${camerax_version}")
  implementation("androidx.camera:camera-camera2:${camerax_version}")
  implementation("androidx.camera:camera-lifecycle:${camerax_version}")
  // the CameraX Extensions library
  implementation("androidx.camera:camera-extensions:${camerax_version}")
    ...
}

Usunięcie starszej wersji interfejsu API

W 1.0.0-alpha26 r. udostępniliśmy nowy interfejs Extensions API, który został udostępniony w sierpniu 2019 r. Wraz z wprowadzeniem wersji 1.0.0-alpha28 starsza wersja interfejsu Extensions API została usunięta z biblioteki. Aplikacje korzystające z nowego interfejsu Extensions API muszą teraz uzyskać CameraSelector z rozszerzeniem i używać go do powiązania przypadków użycia.

Aplikacje korzystające ze starszej wersji interfejsu Extensions API należy przenieść do nowego interfejsu Extensions API, aby zapewnić ich zgodność z nadchodzącymi wersjami CameraX.

Dodatkowe materiały

Więcej informacji o aplikacji CameraX znajdziesz w tych dodatkowych materiałach.

Ćwiczenia z programowania

  • Pierwsze kroki z Aparatem X
  • Przykładowy kod

    Przykładowa aplikacja z rozszerzeniami CameraX

    Inne materiały

    Rozszerzenia dla dostawców CameraX

    Narzędzie do weryfikacji rozszerzeń dostawców CameraX