AR in der Android-App aktivieren

Aktivieren Sie AR, um Augmented-Reality-Funktionen in Ihrer neuen oder bestehenden App zu verwenden.

App so konfigurieren, dass sie 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 die Google Play-Dienste für AR installiert sind.

• Über den Google Play Store werden nur AR-erforderliche Apps auf Geräten zur Verfügung gestellt, die ARCore unterstützen.
• Wenn Nutzer eine App installieren, die für AR erforderlich ist, werden die Google Play-Dienste für AR automatisch aus dem Google Play Store auf ihrem Gerät installiert. Sie müssen für Ihre App jedoch weiterhin zusätzliche Laufzeitprüfungen durchführen, falls die Google Play-Dienste für AR veraltet oder manuell deinstalliert wurden.

Eine App mit der Option AR Optional verwendet ARCore, um vorhandene Funktionen zu verbessern. Sie bietet optionale AR-Funktionen, die nur auf Geräten aktiviert sind, die von ARCore unterstützt werden und 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 optionaler AR-Funktion 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 von AR-Funktionen	Für die Grundfunktionen deiner App ist ARCore erforderlich.	Mit ARCore lässt sich die Funktionalität deiner App erweitern. Zur Ausführung deiner App ist ARCore-Unterstützung erforderlich.
Sichtbarkeit im Play Store	Ihre App wird im Play Store nur auf Geräten, die ARCore unterstützen, aufgeführt.	Ihre App entspricht den normalen Schritten zum Auflisten.
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 4.4 (API-Level 19). Zum Ausführen von AR-Funktionen ist mindestens Android 7.0 (API-Level 24) erforderlich.
Du musst ArCoreApk.checkAvailability() oder ArCoreApk.checkAvailabilityAsync() verwenden, um den ARCore-Support und den Installationsstatus zu prüfen
Sie müssen ArCoreApk.requestInstall() verwenden, um Google Play-Dienste für AR zu installieren

Wenn du möchtest, dass 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 minSdkVersion von mindestens 24 anzugeben:

 android {
     defaultConfig {
         …
         minSdkVersion 24
     }
 }

Build-Abhängigkeiten hinzufügen

So fügen Sie Ihrem Android Studio-Projekt ARCore hinzu:

1. Die Datei build.gradle deines Projekts muss das Maven-Repository von Google enthalten.

   allprojects {
       repositories {
           google()
           …
       }
   }
   

2. Füge die neueste ARCore-Bibliothek als Abhängigkeit in die Datei build.gradle deiner App ein.

   dependencies {
       …
       implementation 'com.google.ar:core:1.33.0'
   }
   

Laufzeitprüfungen durchführen

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

Prüfen, ob ARCore unterstützt wird

Sowohl Apps mit AR erforderlich als auch optional mit AR sollten Sie mit ArCoreApk.checkAvailability() oder ArCoreApk.checkAvailabilityAsync() feststellen, ob das aktuelle Gerät ARCore unterstützt. Auf Geräten, die ARCore nicht unterstützen, sollten Apps AR-bezogene Funktionen deaktivieren und zugehörige UI-Elemente ausblenden.

Kotlin

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

  // Enable AR-related functionality on ARCore supported devices only.
  maybeEnableArButton()
  …
}

fun maybeEnableArButton() {
  ArCoreApk.getInstance().checkAvailabilityAsync(this) { availability ->
    if (availability.isSupported) {
      mArButton.visibility = View.VISIBLE
      mArButton.isEnabled = true
    } else { // The device is unsupported or unknown.
      mArButton.visibility = View.INVISIBLE
      mArButton.isEnabled = false
    }
  }
}

Java

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

  // Enable AR-related functionality on ARCore supported devices only.
  maybeEnableArButton();
  …
}

void maybeEnableArButton() {
  ArCoreApk.getInstance().checkAvailabilityAsync(this, availability -> {
    if (availability.isSupported()) {
      mArButton.setVisibility(View.VISIBLE);
      mArButton.setEnabled(true);
    } else { // The device is unsupported or unknown.
      mArButton.setVisibility(View.INVISIBLE);
      mArButton.setEnabled(false);
    }
  });
}

Obwohl Google Play-Dienste für AR zusammen mit Ihrer App installiert ist, die für AR erforderlich ist, können Nutzer mit nicht unterstützten Geräten die App auch von einer externen Quelle installieren. Wenn du ArCoreApk.checkAvailability() oder ArCoreApk.checkAvailabilityAsync() verwendest, um zu prüfen, ob ARCore unterstützt wird, sorgst du 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 UNKNOWN_CHECKING zurückgegeben. Um die wahrgenommene Latenz und das wahrgenommene Pop-in zu reduzieren, sollten Apps zu Beginn ihres Lebenszyklus einmal ArCoreApk.checkAvailability() 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-erforderlich als auch AR Optionale Apps müssen ArCoreApk.requestInstall() verwenden, bevor eine ARCore-Sitzung erstellt wird. So kann geprüft werden, ob eine kompatible Version der Google Play-Dienste für AR installiert ist und ob alle erforderlichen ARCore-Geräteprofildaten heruntergeladen wurden.

Kotlin

// requestInstall(Activity, true) will triggers installation of
// Google Play Services for AR if necessary.
var mUserRequestedInstall = true

override fun onResume() {
  super.onResume()

  // Check camera permission.
  …

  // Ensure that Google Play Services for AR and ARCore device profile data are
  // installed and up to date.
  try {
    if (mSession == null) {
      when (ArCoreApk.getInstance().requestInstall(this, mUserRequestedInstall)) {
        ArCoreApk.InstallStatus.INSTALLED -> {
          // Success: Safe to create the AR session.
          mSession = Session(this)
        }
        ArCoreApk.InstallStatus.INSTALL_REQUESTED -> {
          // When this method returns `INSTALL_REQUESTED`:
          // 1. ARCore pauses this activity.
          // 2. ARCore prompts the user 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. ARCore resumes this activity. The next invocation of
          //    requestInstall() will either return `INSTALLED` or throw an
          //    exception if the installation or update did not succeed.
          mUserRequestedInstall = false
          return
        }
      }
    }
  } catch (e: UnavailableUserDeclinedInstallationException) {
    // Display an appropriate message to the user and return gracefully.
    Toast.makeText(this, "TODO: handle exception " + e, Toast.LENGTH_LONG)
        .show()
    return
  } catch (…) {
    …
    return  // mSession remains null, since session creation has failed.
  }
  …
}

Java

// requestInstall(Activity, true) will trigger installation of
// Google Play Services for AR if necessary.
private boolean mUserRequestedInstall = true;

@Override
protected void onResume() {
  super.onResume();

  // Check camera permission.
  …

  // Ensure that Google Play Services for AR and ARCore device profile data are
  // installed and up to date.
  try {
    if (mSession == null) {
      switch (ArCoreApk.getInstance().requestInstall(this, mUserRequestedInstall)) {
        case INSTALLED:
          // Success: Safe to create the AR session.
          mSession = new Session(this);
          break;
        case INSTALL_REQUESTED:
          // When this method returns `INSTALL_REQUESTED`:
          // 1. ARCore pauses this activity.
          // 2. ARCore prompts the user 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. ARCore resumes this activity. The next invocation of
          //    requestInstall() will either return `INSTALLED` or throw an
          //    exception if the installation or update did not succeed.
          mUserRequestedInstall = false;
          return;
      }
    }
  } catch (UnavailableUserDeclinedInstallationException e) {
    // Display an appropriate message to the user and return gracefully.
    Toast.makeText(this, "TODO: handle exception " + e, Toast.LENGTH_LONG)
        .show();
    return;
  } catch (…) {
    …
    return;  // mSession remains null, since session creation has failed.
  }
  …
}

Kameraberechtigung anfordern

Sowohl Apps mit AR optional als auch bei AR erforderlich müssen sicherstellen, dass die Kameraberechtigung erteilt wurde, bevor eine AR-Sitzung erstellt wird.

Kotlin

override fun onResume() {
  super.onResume()

  // ARCore requires camera permission to operate.
  if (!CameraPermissionHelper.hasCameraPermission(this)) {
    CameraPermissionHelper.requestCameraPermission(this)
    return
  }

  …
}

Java

@Override
protected void onResume() {
  super.onResume();

  // ARCore requires camera permission to operate.
  if (!CameraPermissionHelper.hasCameraPermission(this)) {
    CameraPermissionHelper.requestCameraPermission(this);
    return;
  }

  …
}

Für Ihre AR-Aktivität muss außerdem onRequestPermissionsResult() implementiert sein.

Kotlin

override fun onRequestPermissionsResult(
  requestCode: Int,
  permissions: Array<String>,
  results: IntArray
) {
  super.onRequestPermissionsResult(requestCode, permissions, results)
  if (!CameraPermissionHelper.hasCameraPermission(this)) {
    Toast.makeText(this, "Camera permission is needed to run this application", Toast.LENGTH_LONG)
      .show()
    if (!CameraPermissionHelper.shouldShowRequestPermissionRationale(this)) {
      // Permission denied with checking "Do not ask again".
      CameraPermissionHelper.launchPermissionSettings(this)
    }
    finish()
  }
}

Java

@Override
public void onRequestPermissionsResult(int requestCode, String[] permissions, int[] results) {
  super.onRequestPermissionsResult(requestCode, permissions, results);
  if (!CameraPermissionHelper.hasCameraPermission(this)) {
    Toast.makeText(this, "Camera permission is needed to run this application", Toast.LENGTH_LONG)
        .show();
    if (!CameraPermissionHelper.shouldShowRequestPermissionRationale(this)) {
      // Permission denied with checking "Do not ask again".
      CameraPermissionHelper.launchPermissionSettings(this);
    }
    finish();
  }
}

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 von ARCore erfüllen.

Weiteres Vorgehen

• Informationen zum Konfigurieren einer ARCore-Sitzung