AR in der Android-App aktivieren

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

App als „AR Required“ 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 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 Required (AR erforderlich) und AR Optional (AR optional). Diese Bezeichnung bestimmt, wie die App mit der App „Google Play-Dienste für AR“ interagiert.

Eine AR Required-App kann ohne ARCore nicht funktionieren. Dazu ist ein ARCore-kompatibles Gerät erforderlich, auf dem die Google Play-Dienste für AR installiert sind.

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

Eine AR Optional-App verwendet ARCore, um vorhandene Funktionen zu verbessern. Die App enthält optionale AR-Funktionen, die nur auf ARCore-kompatiblen Geräten aktiviert werden, auf denen Google Play-Dienste für AR installiert sind.

  • Apps mit optionaler AR-Unterstützung können auf Geräten installiert und ausgeführt werden, die ARCore nicht unterstützen.
  • Wenn Nutzer eine AR Optional-App installieren, werden die Google Play-Dienste für AR nicht automatisch auf dem Gerät installiert.
AR-Berechtigung erforderlichAR-Berechtigung optional
Nutzung von AR-Funktionen Ihre App benötigt ARCore für grundlegende Funktionen. ARCore erweitert die Funktionen Ihrer App. Ihre App kann auch ohne ARCore-Unterstützung ausgeführt werden.
Sichtbarkeit im Google Play Store Ihre App wird im Google Play Store nur auf Geräten mit ARCore-Unterstützung aufgeführt. Für Ihre App gelten die normalen Verfahren für Einträge.
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 für Android minSdkVersion Android 7.0 (API-Level 24) Android 4.4 (API-Level 19). Für die Ausführung von AR-Funktionen ist jedoch mindestens Android 7.0 (API-Level 24) erforderlich.
Sie müssen ArCoreApk.checkAvailability() oder ArCoreApk.checkAvailabilityAsync() verwenden, um die ARCore-Unterstützung und den Installationsstatus zu prüfen.
Sie müssen ArCoreApk.requestInstall() verwenden, um die Google Play-Dienste für AR zu installieren.

Wenn Sie Ihre App als „AR Required“ oder „AR Optional“ kennzeichnen möchten, müssen Sie Ihre AndroidManifest.xml-Datei aktualisieren und die folgenden Einträge hinzufügen:

AR-Berechtigung 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-Berechtigung 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 die build.gradle Ihrer App, um ein minSdkVersion von mindestens 24 anzugeben:

 android {
     defaultConfig {
         
         minSdkVersion 24
     }
 }

Build-Abhängigkeiten hinzufügen

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

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

    allprojects {
        repositories {
            google()
            
        }
    }
    
  2. Fügen Sie die aktuelle ARCore-Bibliothek als Abhängigkeit in die build.gradle-Datei Ihrer 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 ausgeführt werden.

Prüfen, ob ARCore unterstützt wird

Sowohl für Apps, für die AR erforderlich ist, als auch für Apps, für die AR optional ist, 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 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);
    }
  });
}
Auch wenn die Google Play-Dienste für AR zusammen mit Ihrer AR Required-App installiert werden, können Nutzer mit nicht unterstützten Geräten sie möglicherweise aus einer externen Quelle installieren. Wenn Sie ArCoreApk.checkAvailability() oder ArCoreApk.checkAvailabilityAsync() verwenden, um nach ARCore-Unterstützung zu suchen, wird eine einheitliche Nutzererfahrung gewährleistet.

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 Einblenden zu verringern, sollten Apps ArCoreApk.checkAvailability() einmal früh im Lebenszyklus aufrufen, um die Anfrage zu starten. Der zurückgegebene Wert sollte dabei ignoriert werden. So ist ein Ergebnis im Cache sofort verfügbar, wenn ein UI-Element zum Aufrufen von AR angezeigt werden soll.

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

Sowohl für Apps, die ARCore erfordern, als auch für Apps, die ARCore optional nutzen, muss vor dem Erstellen einer ARCore-Sitzung ArCoreApk.requestInstall() verwendet werden, 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.
  }
  
}

Berechtigung zum Zugriff auf die Kamera anfordern

Sowohl für AROptional- als auch für ARRequired-Apps muss die Berechtigung zum Zugriff auf die Kamera erteilt worden sein, 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;
  }

  
}

Ihre AR-Aktivität muss auch onRequestPermissionsResult() implementieren.

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

Datenschutzanforderungen für Nutzer einhalten

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

Weiteres Vorgehen