Włącz AR w aplikacji NDK na Androida

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

Konfigurowanie aplikacji jako wymaganej lub opcjonalnej AR

Aby zaoszczędzić miejsce na poszczególnych urządzeniach, wszystkie funkcje AR są przechowywane w aplikacji o nazwie Usługi Google Play dla AR, która jest aktualizowana oddzielnie 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ę, która obsługuje funkcje AR, można skonfigurować na 2 sposoby: Wymagana rzeczywistość rozszerzona i opcjonalna AR. 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 ARCore, na którym są zainstalowane Usługi Google Play dla AR.

  • Sklep Google Play udostępnia aplikacje wymagane w rzeczywistości rozszerzonej tylko na urządzeniach, które obsługują ARCore.
  • Gdy użytkownicy zainstalują aplikację wymagającą AR, Sklep Google Play automatycznie zainstaluje Usługi Google Play dla AR na ich urządzeniach. Aplikacja nadal musi jednak przeprowadzać dodatkowe kontrole w czasie działania na wypadek, gdyby Usługi Google Play dla AR były nieaktualne lub zostały odinstalowane ręcznie.

Aplikacja opcjonalna AR używa ARCore do ulepszenia dotychczasowych 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 opcjonalne w rzeczywistości rozszerzonej można instalować i uruchamiać na urządzeniach, które nie obsługują ARCore.
  • Gdy użytkownicy zainstalują aplikację opcjonalną AR, Sklep Google Play nie zainstaluje automatycznie Usług Google Play dla AR na urządzeniu.
Wymagana jest ARAR (opcjonalnie)
Wykorzystanie funkcji AR Twoja aplikacja potrzebuje ARCore do obsługi podstawowych funkcji. ARCore zwiększa funkcjonalność Twojej 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 jest zgodna z standardowymi procedurami dotyczącymi zamieszczania informacji.
Metoda instalacji Usług Google Play dla AR Sklep Play instaluje Usługi Google Play dla AR obok Twojej aplikacji. Twoja aplikacja używa usługi ArCoreApk_requestInstall() do pobierania i instalowania ARCore.
Wymagania Androida minSdkVersion Android 7.0 (poziom API 24) Android 7.0 (poziom API 24)
Aby sprawdzić obsługę ARCore i stan instalacji, musisz użyć ArCoreApk_checkAvailability() lub ArCoreApk_checkAvailabilityAsync()
Aby zainstalować Usługi Google Play dla AR, musi używać ArCoreApk_requestInstall()

Aby funkcja AR w aplikacji była wymagana lub opcjonalna, zaktualizuj AndroidManifest.xml, podając te wpisy:

Wymagana jest 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ć minSdkVersion o wartości co najmniej 24:

 android {
     defaultConfig {
         …
         minSdkVersion 24
     }
 }

Dodaj zależności kompilacji

  1. Sprawdź, czy plik build.gradle projektu zawiera repozytorium Google Maven.

    allprojects {
        repositories {
            google()
            …
        }
    }
    
  2. Dodaj niestandardowe zadanie do pliku build.gradle modułu, aby wyodrębnić uwzględnione 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 zdefiniuj zmienną katalogu, do którego 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, 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, by przekazać 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 dla Javy, jak i 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. Odwołuj się do bibliotek natywnych w usłudze 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}
    )
    

Sprawdzanie w czasie działania

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

Sprawdzanie, czy ARCore jest obsługiwane

Aby określić, czy aktualnie używane urządzenie obsługuje ARCore, aplikacje wymagane w przypadku AR i opcjonalne AR powinny używać ArCoreApk_checkAvailability() lub ArCoreApk_checkAvailabilityAsync(). Na urządzeniach, które nie obsługują ARCore, aplikacje powinny wyłączyć funkcje AR i ukryć powiązane elementy interfejsu.

Aplikacja NDK na Androida może używać klasy Java ArCoreApk do sprawdzania zgodności i zarządzania instalacją w natywnym interfejsie C ARCore Session API. 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 w interfejsie i obsługę błędów.

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.
  }
}
Mimo że Usługi Google Play dla AR są zainstalowane razem z aplikacją wymaganą do AR, użytkownicy z nieobsługiwanych urządzeń mogą zainstalować ją ze źródła zewnętrznego. Spójność informacji możesz uzyskać, sprawdzając obsługę ARCore za pomocą ArCoreApk_checkAvailability() lub ArCoreApk_checkAvailabilityAsync().

Aby określić, czy urządzenie obsługuje ARCore, być może ArCoreApk_checkAvailability() będzie musiało wysłać zapytanie do zasobów sieciowych. W tym czasie zostanie zwrócona AR_AVAILABILITY_UNKNOWN_CHECKING. Aby zmniejszyć widoczne opóźnienie i wypytanie, aplikacje powinny wywoływać funkcję ArCoreApk_checkAvailability() raz na początku cyklu życia w celu zainicjowania zapytania, ignorując zwracaną wartość. Dzięki temu wynik z pamięci podręcznej będzie dostępny natychmiast po wyświetleniu elementu interfejsu użytkownika dostępnego w AR.

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

Przed utworzeniem sesji ARCore zarówno aplikacje wymagane, jak i opcjonalne AR muszą wywołać metodę ArCoreApk_requestInstall(), aby sprawdzić, czy zainstalowano (nadal) zgodną wersję Usług Google Play dla AR i upewnić się, że wszystkie wymagane dane z 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.
}

Przestrzegaj wymagań dotyczących prywatności użytkownika

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

Co dalej?