AR in der Android-App aktivieren

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

Konfiguriere deine App als AR-erforderlich oder AR optional.

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 über den Play Store aktualisiert wird. Android-Apps, die AR-Funktionen verwenden, 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 den Google Play-Diensten für AR-App interagiert.

Ohne ARCore funktioniert eine App, die erforderlich für AR ist, nicht. Dafür ist ein mit ARCore unterstütztes Gerät erforderlich, auf dem die Google Play-Dienste für AR installiert sind.

  • Im Google Play Store werden Apps, die mit AR erforderlich sind, nur auf Geräten verfügbar gemacht, die ARCore unterstützen.
  • Wenn Nutzer eine App installieren, die für AR erforderlich ist, werden die Google Play-Dienste für AR automatisch vom Google Play Store auf ihrem Gerät installiert. Ihre App muss jedoch trotzdem zusätzliche Laufzeitprüfungen durchführen, falls Google Play-Dienste für AR veraltet ist oder manuell deinstalliert wurde.

Bei optionalen AR-Apps wird ARCore verwendet, um bestehende Funktionen zu verbessern. Die optionalen AR-Funktionen sind nur auf Geräten verfügbar, die ARCore unterstützen, auf denen die Google Play-Dienste für AR installiert sind.

  • Optionale AR-Apps können auf Geräten, die ARCore nicht unterstützen, installiert und ausgeführt werden.
  • Wenn Nutzer eine optionale AR-App installieren, werden die Google Play-Dienste für AR vom Google Play Store nicht automatisch auf dem Gerät installiert.
AR erforderlichOptionale AR
Nutzung der AR-Funktion Für die grundlegenden Funktionen deiner App ist ARCore erforderlich. ARCore erweitert die Funktionalität deiner App. Deine App kann ohne ARCore-Unterstützung ausgeführt werden.
Sichtbarkeit im Play Store Ihre App wird im Play Store nur auf Geräten veröffentlicht, die ARCore unterstützen. Ihre App folgt den üblichen Verfahren für Einträge.
Installationsmethode für Google Play-Dienste für AR Der Play Store installiert zusammen mit Ihrer App die Google Play-Dienste für AR. Deine App verwendet <ph type="x-smartling-placeholder"></ph> 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 jedoch 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
Muss verwendet werden <ph type="x-smartling-placeholder"></ph> ArCoreApk.requestInstall() um Google Play-Dienste für AR zu installieren

Wenn du festlegen möchtest, dass deine App AR erforderlich oder optional ist, musst du deine AndroidManifest.xml so ändern, 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>

Optionale AR

<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 die 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 aktuelle ARCore-Bibliothek als Abhängigkeit in der Datei build.gradle deiner App hinzu.

    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 AR-Funktionen in Ihrer App reibungslos funktionieren.

Prüfen, ob ARCore unterstützt wird

Sowohl in AR-Apps als auch bei optionalen AR-Apps sollte über ArCoreApk.checkAvailability() oder ArCoreApk.checkAvailabilityAsync() festgestellt werden, ob das aktuelle Gerät ARCore unterstützt. Auf Geräten, die ARCore nicht unterstützen, sollten in Apps AR-bezogene Funktionen deaktiviert und zugehörige UI-Elemente ausgeblendet werden.

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);
    }
  });
}
Google Play-Dienste für AR wird zwar zusammen mit deiner App für AR erforderlich installiert, Nutzer mit nicht unterstützten Geräten installieren sie aber möglicherweise von einer externen Quelle. Mit ArCoreApk.checkAvailability() oder ArCoreApk.checkAvailabilityAsync() kannst du prüfen, ob ARCore-Support für dich verfügbar ist.

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. Zur Reduzierung der wahrgenommenen Latenz und des Pop-in-Fensters sollten Apps zu Beginn des Lebenszyklus einmal ArCoreApk.checkAvailability() aufrufen, um die Abfrage zu starten. Der zurückgegebene Wert wird dabei ignoriert. Auf diese Weise ist ein im Cache gespeichertes Ergebnis sofort verfügbar, wenn ein UI-Element zum Eintreten in AR angezeigt wird.

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

Sowohl für AR required als auch für AR optionale Apps muss Folgendes verwendet werden: <ph type="x-smartling-placeholder"></ph> ArCoreApk.requestInstall() bevor Sie eine ARCore-Sitzung erstellen, um zu prüfen, ob eine kompatible Version der Google Play-Dienste für AR (noch) 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 für die optionale AR-App als auch für die für AR erforderliche App muss die Kameraberechtigung erteilt werden, bevor eine AR-Sitzung erstellt werden kann.

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

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 du deine App im Play Store veröffentlichen kannst, muss sie den ARCore-Richtlinien entsprechen Datenschutzanforderungen für Nutzer.

Weiteres Vorgehen