AR in der Android-App aktivieren

Aktivieren Sie AR, um AR-Funktionen in Ihrer neuen oder vorhandenen App zu verwenden.

Ihre App als „AR erforderlich“ oder „AR optional“ konfigurieren

Um Speicherplatz auf einzelnen Geräten zu sparen, werden alle AR-Funktionen in einer App namens Google Play-Dienste für AR gespeichert, die vom Play Store separat 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 Angabe bestimmt, wie die App mit der App „Google Play-Dienste für AR“ interagiert.

Eine App mit der Kennzeichnung AR erforderlich funktioniert ohne ARCore nicht. Es ist ein ARCore-kompatibles Gerät mit installierten Google Play-Diensten für AR erforderlich.

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

In einer AR-optionalen App wird ARCore verwendet, um vorhandene Funktionen zu verbessern. Es bietet optionale AR-Funktionen, die nur auf ARCore-kompatiblen Geräten aktiviert werden, auf denen die 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 optionale AR-App installieren, werden die Google Play-Dienste für AR nicht automatisch vom Google Play Store auf dem Gerät installiert.

	AR erforderlich	AR optional
Nutzung der AR-Funktion	Ihre App benötigt ARCore für die grundlegenden Funktionen.	ARCore erweitert die Funktionen Ihrer App. Ihre App kann auch ohne ARCore-Unterstützung ausgeführt werden.
Sichtbarkeit im Play Store	Ihre App wird nur auf Geräten mit ARCore-Unterstützung im Play Store aufgeführt.	Für Ihre App gelten die normalen Eintragsverfahren.
Installationsmethode für Google Play-Dienste für AR	Der Play Store installiert die Google Play-Dienste für AR zusammen mit Ihrer App.	Ihre App verwendet `ArCoreApk.requestInstall()` , um ARCore herunterzuladen und zu installieren.
Anforderungen an Android `minSdkVersion`	Android 7.0 (API-Level 24)	Android 4.4 (API-Ebene 19). Für die Ausführung von AR-Funktionen ist jedoch mindestens Android 7.0 (API-Ebene 24) erforderlich.
Sie müssen `ArCoreApk.checkAvailability()` oder `ArCoreApk.checkAvailabilityAsync()` verwenden, um den ARCore-Support und den Installationsstatus zu prüfen.
Sie müssen `ArCoreApk.requestInstall()` verwenden, um die Google Play-Dienste für AR zu installieren.

Wenn Sie festlegen möchten, dass für Ihre App AR erforderlich oder optional ist, aktualisieren Sie AndroidManifest.xml und fügen Sie die folgenden Einträge hinzu:

AR erforderlichAR optional

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

<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 eine minSdkVersion von mindestens 24 anzugeben:

 android {
     defaultConfig {
         …
         minSdkVersion 24
     }
 }

Build-Abhängigkeiten hinzufügen

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

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

allprojects {
    repositories {
        google()
        …
    }
}

Fügen Sie die neueste ARCore-Bibliothek als Abhängigkeit in die build.gradle-Datei Ihrer 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 bei Apps, für die AR erforderlich ist, als auch bei Apps, für die AR optional ist, sollte ArCoreApk.checkAvailability() oder ArCoreApk.checkAvailabilityAsync() verwendet werden, um zu ermitteln, 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.

KotlinJava

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

@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 sind, können Nutzer mit nicht unterstützten Geräten sie aus einer externen Quelle installieren. Wenn Sie ArCoreApk.checkAvailability() oder ArCoreApk.checkAvailabilityAsync() verwenden, um die ARCore-Unterstützung zu prüfen, ist die Funktion immer verfügbar.

ArCoreApk.checkAvailability() muss möglicherweise Netzwerkressourcen abfragen, um festzustellen, ob das Gerät ARCore unterstützt. In dieser Zeit wird UNKNOWN_CHECKING zurückgegeben. Um die wahrgenommene Latenz und das Pop-in zu reduzieren, sollten Apps ArCoreApk.checkAvailability() einmal zu Beginn des Lebenszyklus aufrufen, um die Abfrage zu starten, und den zurückgegebenen Wert ignorieren. So ist ein im Cache gespeichertes Ergebnis sofort verfügbar, wenn ein UI-Element für die AR-Eingabe angezeigt werden könnte.

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

Sowohl für Apps mit AR-Erfordernis als auch für Apps mit optionaler AR-Funktion muss ArCoreApk.requestInstall() verwendet werden, bevor eine ARCore-Sitzung erstellt wird, 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.

KotlinJava

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

// 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 Apps mit optionaler AR-Funktion als auch bei Apps mit AR-Funktion ist dafür zu sorgen, dass die Kameraberechtigung erteilt wurde, bevor eine AR-Sitzung erstellt wird.

KotlinJava

override fun onResume() {
  super.onResume()

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

  …
}

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

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

  …
}

Ihre AR-Aktivität muss außerdem onRequestPermissionsResult() implementieren.

KotlinJava

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

@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();
  }
}

Datenschutzanforderungen für Nutzer erfüllen

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

Weiteres Vorgehen

Weitere Informationen zum Konfigurieren einer ARCore-Sitzung