AR in der Android-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 erforderlichAR 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

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

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

    allprojects {
    repositories {
        google()
        …
    }
}

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

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

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.

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);
    }
  });
}
Auch wenn Google Play-Dienste für AR zusammen mit Ihrer AR-erforderlichen App installiert ist, installieren Nutzer mit nicht unterstützten Geräten sie möglicherweise aus einer externen Quelle. 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 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.

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 bei den Apps „AR optional“ und „AR erforderlich“ muss vor der Erstellung einer AR-Sitzung sichergestellt werden, dass die Kameraberechtigung erteilt wurde.

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 deine AR-Aktivitäten muss auch 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 für Nutzer von ARCore erfüllen.

Nächste Schritte