Włącz AR w aplikacji NDK na Androida

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

Skonfiguruj aplikację jako wymagana AR lub opcjonalna AR

Aby zaoszczędzić miejsce na poszczególnych urządzeniach, wszystkie funkcje AR są przechowywane w aplikacji Usługi Google Play dla AR, którą aktualizuje Sklep Play. Aplikacje na Androida, które używają funkcji AR, komunikują się z Usługami Google Play dla AR za pomocą pakietu ARCore SDK. Aplikację obsługującą funkcje AR można skonfigurować na 2 sposoby: jako AR wymagana lub AR opcjonalna. To oznaczenie określa sposób interakcji aplikacji z Usługami Google Play dla AR.

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

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

Aplikacja opcjonalna AR wykorzystuje ARCore do ulepszania istniejących funkcji. Obejmuje opcjonalne funkcje AR, które są aktywowane tylko na obsługiwanych urządzeniach ARCore, na których zainstalowano Usługi Google Play dla AR.

  • Opcjonalne aplikacje AR można instalować i uruchamiać na urządzeniach, które nie obsługują ARCore.
  • Gdy użytkownicy instalują opcjonalną aplikację AR, Sklep Google Play nie automatycznie instaluje na urządzeniu Usług Google Play dla AR.
Wymagana ARAR opcjonalnie
Wykorzystanie funkcji AR Twoja aplikacja potrzebuje ARCore do podstawowych funkcji. ARCore zwiększa funkcjonalność aplikacji. Twoja aplikacja może działać bez obsługi ARCore.
Widoczność w Sklepie Play Aplikacja jest dostępna w Sklepie Play tylko na urządzeniach obsługujących ARCore. Aplikacja działa zgodnie ze standardowymi procedurami.
Metoda instalacji Usług Google Play dla AR Sklep Play zainstaluje obok Twojej aplikacji Usługi Google Play dla AR. Twoja aplikacja używa ArCoreApk_requestInstall() do pobrania i zainstalowania ARCore.
Wymagania minSdkVersion w Androidzie Android 7.0 (poziom API 24) Android 7.0 (poziom API 24)
Aby sprawdzić działanie zespołu pomocy i instalację ARCore, musisz użyć narzędzia ArCoreApk_checkAvailability() lub ArCoreApk_checkAvailabilityAsync()
Aby zainstalować Usługi Google Play dla AR, należy użyć aplikacji ArCoreApk_requestInstall()

Aby aplikacja mogła być wymagana w trybie AR lub opcjonalna w AR, zaktualizuj AndroidManifest.xml i dodaj te wpisy:

Wymagana AR

<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>

AR opcjonalnie

<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 zmień build.gradle w aplikacji, aby określić wartość minSdkVersion na poziomie co najmniej 24:

 android {
     defaultConfig {
         …
         minSdkVersion 24
     }
 }

Dodaj zależności kompilacji

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

    allprojects {
        repositories {
            google()
            …
        }
    }
    
  2. Dodaj niestandardowe zadanie 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 C lub C++.

  3. W katalogu app/build określ zmienną wskazującą, do której będą wyodrębnione biblioteki natywne.

  4. utworzyć konfigurację Gradle do przechowywania danych i 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, aby skopiować biblioteki natywne z pliku AAR i dodać 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 kompilacji natywnej, aby przekazywać lokalizacje do zewnętrznych narzędzi do 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 w języku Java, jak i w bibliotekach 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. Skorzystaj z bibliotek natywnych w sekcji 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 środowisko wykonawcze

W czasie działania aplikacji wykonaj te czynności, by funkcje AR w aplikacji działały płynnie.

Sprawdź, czy ARCore jest obsługiwany

Zarówno w przypadku AR, jak i opcjonalnych aplikacji AR należy użyć ArCoreApk_checkAvailability() lub ArCoreApk_checkAvailabilityAsync(), aby określić, czy obecne urządzenie obsługuje ARCore. Na urządzeniach, które nie obsługują ARCore, aplikacje powinny wyłączyć funkcje związane z AR i ukryć powiązane elementy interfejsu.

Aplikacja NDK na Androida może używać klasy Java ArCoreApk, aby sprawdzać zgodność i zarządzać instalacją w natywnym interfejsie API ARCore Session. W zależności od struktury Twojej aplikacji może to być łatwiejsze niż używanie funkcji ArCoreApk_ ze względu na dużą liczbę błędów obsługi i interakcję w interfejsie.

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.
  }
}
Nawet jeśli Usługi Google Play dla AR są instalowane razem z aplikacją AR, użytkownicy nieobsługiwanych urządzeń mogą ją zainstalować z zewnętrznego źródła. Korzystanie z narzędzia ArCoreApk_checkAvailability() lub ArCoreApk_checkAvailabilityAsync() do sprawdzenia, czy jest dostępna obsługa ARCore, zapewnia spójne wrażenia.

Aby określić, czy urządzenie obsługuje ARCore, konieczne może być użycie zapytań sieciowych dotyczących zasobów ArCoreApk_checkAvailability(). W tym czasie zwraca wartość AR_AVAILABILITY_UNKNOWN_CHECKING. Aby zmniejszyć postrzegane opóźnienie i wyostrzenie danych, aplikacje powinny wywoływać metodę ArCoreApk_checkAvailability() na początku cyklu życia zapytania, aby zignorować zwrócone wartości. Dzięki temu wynik będzie przechowywany w pamięci podręcznej, gdy tylko pojawi się element interfejsu AR.

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

Przed utworzeniem sesji ARCore aplikacje zarówno wymagane przez AR, jak i opcjonalne w rzeczywistości rozszerzonej muszą wywołać metodę ArCoreApk_requestInstall(), by sprawdzić, czy zainstalowana jest zgodna wersja Usług Google Play dla AR, i upewnić się, że wszystkie wymagane dane profilu 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.
}

Przestrzeganie wymagań dotyczących prywatności użytkowników

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

Co dalej?