AR in der Android NDK App aktivieren

Aktiviere AR, um Augmented-Reality-Funktionen in deiner neuen oder bestehenden App zu verwenden.

App so konfigurieren, dass AR erforderlich oder AR optional ist

Um auf einzelnen Geräten Platz zu sparen, werden alle AR-Funktionen in einer App namens Google Play-Dienste für AR gespeichert, die separat vom Play Store aktualisiert wird. Android-Apps, die AR-Funktionen nutzen, kommunizieren über das ARCore SDK mit den Google Play-Diensten für AR. Eine App, die AR-Funktionen unterstützt, kann auf zwei Arten konfiguriert werden: AR erforderlich und AR optional. Diese Kennzeichnung bestimmt, wie die App mit der Google Play Services for AR App interagiert.

Apps, die erforderlich sind, funktionieren ohne ARCore nicht. Dafür ist ein ARCore-unterstütztes Gerät erforderlich, auf dem Google Play-Dienste für AR installiert sind.

• Über den Google Play Store werden Apps, die mit AR kompatibel sind, nur auf Geräten verfügbar gemacht, die ARCore unterstützen.
• Wenn Nutzer eine App installieren, für die eine AR erforderlich ist, werden die Google Play-Dienste für AR automatisch aus dem Google Play Store auf ihrem Gerät installiert. Für den Fall, dass die Google Play-Dienste für AR veraltet oder manuell deinstalliert wurden, müssen für Ihre App weiterhin zusätzliche Laufzeitprüfungen durchgeführt werden.

Eine optionale AR-App nutzt ARCore, um vorhandene Funktionen zu erweitern. Es verfügt über optionale AR-Funktionen, die nur auf Geräten mit ARCore-Unterstützung aktiviert sind, auf denen Google Play-Dienste für AR installiert sind.

• Optionale AR-Apps können auf Geräten installiert und ausgeführt werden, die ARCore nicht unterstützen.
• Wenn Nutzer eine App mit optionalem AR-Modus installieren, werden die Google Play-Dienste für AR nicht automatisch aus dem Google Play Store auf dem Gerät installiert.

	AR erforderlich	AR optional
Nutzung der AR-Funktion	Für die Grundfunktionen deiner App ist ARCore erforderlich.	ARCore steigert die Funktionalität deiner App. Deine App läuft ohne ARCore-Unterstützung.
Sichtbarkeit im Play Store	Ihre App wird im Play Store nur auf Geräten, die ARCore unterstützen, aufgeführt.	Ihre App folgt den normalen Schritten für Einträge.
Installationsmethode für Google Play-Dienste für AR	Über den Play Store werden die Google Play-Dienste für AR zusammen mit Ihrer App installiert.	Deine App verwendet ArCoreApk_requestInstall(), um ARCore herunterzuladen und zu installieren.
Anforderungen für Android minSdkVersion	Android 7.0 (API-Level 24)	Android 7.0 (API-Level 24)
Du musst ArCoreApk_checkAvailability() oder ArCoreApk_checkAvailabilityAsync() verwenden, um den ARCore-Support und den Installationsstatus zu prüfen
Du musst ArCoreApk_requestInstall() verwenden, um Google Play-Dienste für AR zu installieren

Damit deine App AR erforderlich oder AR optional ist, aktualisiere deine AndroidManifest.xml so, dass sie die folgenden Einträge enthält:

AR erforderlich

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

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

Ändern Sie dann den build.gradle Ihrer App, um einen minSdkVersion von mindestens 24 anzugeben:

 android {
     defaultConfig {
         …
         minSdkVersion 24
     }
 }

Build-Abhängigkeiten hinzufügen

1. Achten Sie darauf, dass die Datei build.gradle Ihres Projekts das Maven-Repository von Google enthält.

   allprojects {
       repositories {
           google()
           …
       }
   }
   

2. Fügen Sie der Datei build.gradle Ihres Moduls eine benutzerdefinierte Aufgabe hinzu, um enthaltene native Bibliotheken aus der ARCore-Datei AAR zu extrahieren. Auf diese Weise kann in einem C- oder C++-Projekt direkt auf sie verwiesen werden.

3. Definieren Sie im Verzeichnis app/build eine Variable für das Verzeichnis, in das die nativen Bibliotheken extrahiert werden.

4. Erstellen Sie eine Gradle-Konfiguration für die Daten- und Extraktionsaufgaben.

   /*
   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. Erstellen Sie eine Aufgabe, um die nativen Bibliotheken aus der AAR-Datei zu kopieren, und fügen Sie sie den Build-Abhängigkeiten hinzu.

   // 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. Konfigurieren Sie die nativen Build-Flags, um die Speicherorte an die externen Build-Tools zu übergeben.

   // 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. Fügen Sie die Abhängigkeiten für die Java- und die nativen Bibliotheken hinzu.

   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. Verweisen Sie in CMakeLists.txt auf die nativen Bibliotheken.

   # 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}
   )
   

Laufzeitprüfungen ausführen

Führen Sie während der Laufzeit die folgenden Schritte aus, damit die AR-Funktionen in Ihrer App reibungslos funktionieren.

Prüfen, ob ARCore unterstützt wird

Sowohl für Apps mit AR erforderlich als auch für optionale AR sollte ArCoreApk_checkAvailability() oder ArCoreApk_checkAvailabilityAsync() verwendet werden, um festzustellen, ob das aktuelle Gerät ARCore unterstützt. Auf Geräten, die ARCore nicht unterstützen, sollten Apps die AR-Funktionen deaktivieren und zugehörige UI-Elemente ausblenden.

Eine Android-NDK-App kann die Java-Klasse ArCoreApk verwenden, um die Kompatibilität zu prüfen und die Installation in der nativen C ARCore Session API zu verwalten. Je nach Struktur Ihrer App kann dies einfacher sein als die Verwendung der ArCoreApk_-Funktionen, da eine hohe Fehlerbehandlung und viele Interaktionen auf der Benutzeroberfläche erforderlich sind.

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

Auch wenn Google Play-Dienste für AR zusammen mit der App installiert wird, die für AR erforderlich ist, kann es vorkommen, dass Nutzer mit nicht unterstützten Geräten die App aus einer externen Quelle installieren. Wenn du ArCoreApk_checkAvailability() oder ArCoreApk_checkAvailabilityAsync() verwendest, um zu prüfen, ob ARCore unterstützt wird, sorge für eine einheitliche Funktionsweise.

ArCoreApk_checkAvailability() muss möglicherweise Netzwerkressourcen abfragen, um festzustellen, ob das Gerät ARCore unterstützt. Während dieser Zeit wird AR_AVAILABILITY_UNKNOWN_CHECKING zurückgegeben. Um die wahrgenommene Latenz und das Pop-in-Fenster zu reduzieren, sollten Apps ArCoreApk_checkAvailability() einmal zu Beginn ihres Lebenszyklus aufrufen, um die Abfrage zu starten, und dabei den zurückgegebenen Wert ignorieren. Auf diese Weise steht ein im Cache gespeichertes Ergebnis sofort zur Verfügung, wenn ein AR-Einstiegs-UI-Element angezeigt wird.

Prüfen, ob Google Play-Dienste für AR installiert ist

Sowohl AR-erforderliche Apps als auch optionale AR-Apps müssen ArCoreApk_requestInstall() aufrufen, bevor eine ARCore-Sitzung erstellt wird. So lässt sich prüfen, ob eine kompatible Version der Google Play-Dienste für AR installiert ist und ob alle erforderlichen ARCore-Geräteprofildaten heruntergeladen wurden.

// 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.
}

Anforderungen an den Datenschutz für Nutzer erfüllen

Damit Sie Ihre App im Play Store veröffentlichen können, muss sie die Anforderungen an den Datenschutz für Nutzer von ARCore erfüllen.

Nächste Schritte

• Informationen zur Konfiguration einer ARCore-Sitzung