Włącz AR w aplikacji NDK na Androida

Włącz AR, aby korzystać z funkcji rzeczywistości rozszerzonej w nowej lub istniejącej aplikacji.

Skonfiguruj aplikację tak, aby była wymagana w trybie AR lub jako opcjonalna

Aby oszczędzać miejsce na poszczególnych urządzeniach, wszystkie funkcje AR są przechowywane w aplikacji Usługi Google Play dla AR, która jest aktualizowana osobno przez Sklep Play. Aplikacje na Androida, które używają funkcji AR, komunikują się z Usługami Google Play dla AR za pomocą pakietu SDK ARCore. Aplikację obsługującą funkcje AR można skonfigurować na 2 sposoby: AR wymagane i AR opcjonalne. To oznaczenie określa, jak aplikacja współpracuje z aplikacją Usługi Google Play dla AR.

Aplikacja Wymagana AR nie może działać bez ARCore. Wymaga urządzenia obsługującego ARCore, na którym są zainstalowane Usługi Google Play dla AR.

• W Sklepie Google Play będą dostępne tylko aplikacje wymagane przez AR na urządzeniach, które obsługują ARCore.
• Gdy użytkownicy instalują aplikację wymagającą AR, Sklep Google Play automatycznie zainstaluje na ich urządzeniu Usługi Google Play dla AR. Aplikacja musi jednak nadal przeprowadzić dodatkowe kontrole w czasie działania, jeśli Usługi Google Play dla AR są nieaktualne lub zostały odinstalowane ręcznie.

Aplikacja opcjonalnie AR używa ARCore do rozszerzania istniejących funkcji. Zawiera opcjonalne funkcje AR, które są aktywowane tylko na urządzeniach obsługujących ARCore, na których zainstalowano Usługi Google Play dla AR.

• Aplikacje AR opcjonalne można instalować i uruchamiać na urządzeniach, które nie obsługują ARCore.
• Gdy użytkownik zainstaluje opcjonalną aplikację AR, Sklep Google Play nie zainstaluje na urządzeniu Usług Google Play dla AR na urządzeniu.

Aby ustawić wymaganą lub opcjonalną obsługę AR w aplikacji, zaktualizuj plik AndroidManifest.xml, aby zawierał te wpisy:

<uses-permission android:name="android.permission.CAMERA" />

<!-- Limits app visibility in the Google Play Store to ARCore supported devices
     (https://developers.google.com/ar/devices). -->
<uses-feature android:name="android.hardware.camera.ar" />

<application …>
    …

    <!-- "AR Required" app, requires "Google Play Services for AR" (ARCore)
         to be installed, as the app does not include any non-AR features. -->
    <meta-data android:name="com.google.ar.core" android:value="required" />
</application>

<uses-permission android:name="android.permission.CAMERA" />

<!-- If your app was previously AR Required, don't forget to remove the
     `<uses-feature android:name="android.hardware.camera.ar" />` entry, as
     this would limit app visibility in the Google Play Store to only
     ARCore supported devices. -->

<application …>
    …

    <!-- "AR Optional" app, contains non-AR features that can be used when
         "Google Play Services for AR" (ARCore) is not available. -->
    <meta-data android:name="com.google.ar.core" android:value="optional" />
</application>

Następnie zmodyfikuj build.gradle aplikacji, aby określić minSdkVersion o wartości co najmniej 24:

 android {
     defaultConfig {
         …
         minSdkVersion 24
     }
 }

Dodaj zależności kompilacji

1. Upewnij się, że plik build.gradle projektu zawiera repozytorium Maven firmy Google.

   allprojects {
       repositories {
           google()
           …
       }
   }
   

2. Dodaj zadanie niestandardowe do pliku build.gradle modułu, aby wyodrębnić dołączone biblioteki natywne z pliku ARCore AAR. Dzięki temu można się do nich odwoływać bezpośrednio w projekcie w języku C lub C++.

3. W katalogu app/build zdefiniuj zmienną określającą katalog, w którym zostaną wyodrębnione biblioteki natywne.

4. Utwórz konfigurację Gradle do przechowywania danych i zadań wyodrębniania.

   /*
   The ARCore AAR library contains native shared libraries that are
   extracted before building to a temporary directory.
   */
   def arcore_libpath = "${buildDir}/arcore-native"
   
   // Create a configuration to mark which aars to extract .so files from
   configurations { natives }
   

5. Utwórz zadanie kopiowania bibliotek natywnych z pliku AAR i dodaj je do zależności kompilacji.

   // Extracts the shared libraries from AARs in the native configuration
   // so that NDK builds can access these libraries.
   task extractNativeLibraries() {
      // Extract every time.
      outputs.upToDateWhen { false }
   
      doFirst {
           configurations.natives.files.each { f ->
               copy {
                   from zipTree(f)
                   into arcore_libpath
                   include "jni/**/*"
               }
           }
       }
   }
   
   tasks.whenTaskAdded {
       task-> if (task.name.contains("external") && !task.name.contains("Clean")) {
           task.dependsOn(extractNativeLibraries)
       }
   }
   

6. Skonfiguruj flagi natywnych kompilacji, aby przekazywać lokalizacje do zewnętrznych narzędzi kompilacji.

   // From the sample app.
   externalNativeBuild {
       cmake {
           cppFlags "-std=c++11", "-Wall"
           arguments "-DANDROID_STL=c++_static",
                   "-DARCORE_LIBPATH=${arcore_libpath}/jni",
                   "-DARCORE_INCLUDE=${project.rootDir}/../../libraries/include"
       }
   }
   

7. Dodaj zależności zarówno dla bibliotek Java, jak i dla bibliotek natywnych.

   dependencies {
        ...
        // Add Java and native dependencies to the ARCore library.
        implementation 'com.google.ar:core:1.33.0'
        natives 'com.google.ar:core:1.33.0'
        ...
   }
   

8. Korzystaj z bibliotek natywnych w języku: CMakeLists.txt.

   # Import the ARCore library.
   add_library(arcore SHARED IMPORTED)
   set_target_properties(arcore PROPERTIES IMPORTED_LOCATION
                 ${ARCORE_LIBPATH}/${ANDROID_ABI}/libarcore_sdk_c.so
                 INTERFACE_INCLUDE_DIRECTORIES ${ARCORE_INCLUDE}
   )
   

Sprawdzaj czas działania

Aby funkcje AR w aplikacji działały płynnie w czasie jej działania, wykonaj te czynności:

Sprawdzanie, czy ARCore jest obsługiwane

Aplikacja na Androida korzystająca z NDK może używać klasy Java ArCoreApk do sprawdzania zgodności i zarządzania instalacją w natywnym interfejsie ARCore Session API w języku C. W zależności od struktury aplikacji może to być łatwiejsze niż korzystanie z funkcji ArCoreApk_ ze względu na dużą liczbę błędów i interakcję z interfejsem.

void maybeEnableArButton(JNIEnv env, jobject context) {
  // Likely called from Activity.onCreate() of an activity with AR buttons.
  ArAvailability availability
  ArCoreApk_checkAvailability(env, context, &availability);
  if (availability == AR_AVAILABILITY_UNKNOWN_CHECKING) {
    // Set a timer to call maybeEnableArButton() again after about 200ms.
  }
  if (availability == AR_AVAILABILITY_SUPPORTED_NOT_INSTALLED ||
      availability == AR_AVAILABILITY_SUPPORTED_APK_TOO_OLD ||
      availability == AR_AVAILABILITY_SUPPORTED_INSTALLED) {
    // Show or enable the AR button.
  } else {
    // Hide or disable the AR button.
  }
}

ArCoreApk_checkAvailability() może wysyłać zapytania do zasobów sieciowych, aby określić, czy urządzenie obsługuje ARCore. W tym czasie funkcja będzie zwracana AR_AVAILABILITY_UNKNOWN_CHECKING. Aby zmniejszyć odczuwalny czas oczekiwania i wyświetlania wyskakujących okienek, aplikacje powinny wywołać funkcję ArCoreApk_checkAvailability() raz na początku cyklu życia, aby zainicjować zapytanie, ignorując zwróconą wartość. Dzięki temu wynik z pamięci podręcznej będzie dostępny od razu, gdy może zostać wyświetlony element interfejsu korzystający z AR.

Sprawdzanie, czy Usługi Google Play dla AR są zainstalowane

Zarówno aplikacje z wymaganiami AR, jak i aplikacje z opcjonalnym AR muszą korzystać z  ArCoreApk.requestInstall() przed utworzeniem sesji ARCore, aby sprawdzić, czy kompatybilna wersja Usług Google Play dla AR jest (nadal) zainstalowana, oraz czy wszystkie wymagane dane profilu urządzenia ARCore zostały pobrane.

// Tracks if an installation request has already been triggered.
bool install_requested_;

void nativeOnCreate() {
  // Do other setup here.

  install_requested_ = false;
}

void nativeOnResume(JNIEnv env, jobject activity) {
  if (ar_session_ == null) {
    bool user_requested_install = !install_requested_;

    ArInstallStatus install_status;
    // Ensure that Google Play Services for AR and ARCore device profile data are
    // installed and up to date.
    ArStatus error = ArCoreApk_requestInstall(
        env, activity, user_requested_install, &install_status);
    if (error != AR_SUCCESS) {
      // Inform user of error.
      return;
    }

    switch (install_status) {
      case AR_INSTALL_STATUS_INSTALLED:
        break;
      case AR_INSTALL_STATUS_INSTALL_REQUESTED:
        // When this method returns AR_INSTALL_STATUS_INSTALL_REQUESTED:
        // 1. This activity will be paused.
        // 2. The user is prompted to install or update Google Play
        //    Services for AR (market://details?id=com.google.ar.core).
        // 3. ARCore downloads the latest device profile data.
        // 4. This activity is resumed. The next invocation of
        //    ArCoreApk_requestInstall() will either return
        //    AR_INSTALL_STATUS_INSTALLED or throw an exception if the
        //    installation or update did not succeed.
        install_requested_ = true;
        return;
    }

    // Request camera permissions.

    error = ArSession_create(env, context, &ar_session_);
    if (error != AR_SUCCESS) {
      // Inform user of error.
      return;
    }

    // Configure the ARCore session.
  }

  // Normal onResume behavior.
}

Zapewnienie zgodności z wymaganiami dotyczącymi prywatności użytkowników

Aby opublikować aplikację w Sklepie Play, upewnij się, że jest ona zgodna z Wymagania dotyczące prywatności użytkownika.

Co dalej?

• Dowiedz się, jak skonfigurować sesję ARCore.