Włącz AR w aplikacji na Androida

Włącz AR w nowej lub istniejącej aplikacji, aby korzystać z funkcji rzeczywistości rozszerzonej.

Skonfiguruj aplikację jako wymagana AR lub opcjonalna AR

Aby zaoszczędzić miejsce na poszczególnych urządzeniach, wszystkie funkcje AR są przechowywane w aplikacji Usługi Google Play dla AR, którą aktualizuje Sklep Play. Aplikacje na Androida, które używają funkcji AR, komunikują się z Usługami Google Play dla AR za pomocą pakietu ARCore SDK. Aplikację obsługującą funkcje AR można skonfigurować na 2 sposoby: jako AR wymagana lub AR opcjonalna. To oznaczenie określa sposób interakcji aplikacji z Usługami Google Play dla AR.

Aplikacja wymagana AR nie może działać bez ARCore. Wymaga urządzenia obsługującego ARAR, na którym zainstalowano Usługi Google Play dla AR.

• W Sklepie Google Play aplikacje AR AR będą dostępne tylko na urządzeniach obsługujących ARCore.
• Gdy użytkownicy instalują aplikację AR AR, Sklep Google Play automatycznie instaluje Usługi Google Play na AR na ich urządzeniach. Aplikacja musi jednak przeprowadzić dodatkowe testy w czasie działania, jeśli Usługi Google Play dla AR są nieaktualne lub zostały odinstalowane ręcznie.

Aplikacja opcjonalna AR wykorzystuje ARCore do ulepszania istniejących funkcji. Obejmuje opcjonalne funkcje AR, które są aktywowane tylko na obsługiwanych urządzeniach ARCore, na których zainstalowano Usługi Google Play dla AR.

• Opcjonalne aplikacje AR można instalować i uruchamiać na urządzeniach, które nie obsługują ARCore.
• Gdy użytkownicy instalują opcjonalną aplikację AR, Sklep Google Play nie automatycznie instaluje na urządzeniu Usług Google Play dla AR.

Aby aplikacja mogła być wymagana w trybie AR lub opcjonalna w AR, zaktualizuj AndroidManifest.xml i dodaj te wpisy:

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

Następnie zmień build.gradle w aplikacji, aby określić wartość minSdkVersion na poziomie co najmniej 24:

 android {
     defaultConfig {
         …
         minSdkVersion 24
     }
 }

Dodaj zależności kompilacji

Aby dodać ARCore do projektu Android Studio:

1. Upewnij się, że plik build.gradle projektu zawiera repozytorium Google Maven.

   allprojects {
       repositories {
           google()
           …
       }
   }
   

2. Dodaj najnowszą bibliotekę ARCore jako zależność w pliku build.gradle aplikacji.

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

Sprawdzaj środowisko wykonawcze

W czasie działania aplikacji wykonaj te czynności, by funkcje AR w aplikacji działały płynnie.

Sprawdź, czy ARCore jest obsługiwany

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

Aby określić, czy urządzenie obsługuje ARCore, konieczne może być użycie zapytań sieciowych dotyczących zasobów ArCoreApk.checkAvailability(). W tym czasie zwraca wartość UNKNOWN_CHECKING. Aby zmniejszyć postrzegane opóźnienie i wyostrzenie danych, aplikacje powinny wywoływać metodę ArCoreApk.checkAvailability() na początku cyklu życia zapytania, aby zignorować zwrócone wartości. Dzięki temu wynik będzie przechowywany w pamięci podręcznej, gdy tylko pojawi się element interfejsu AR.

Sprawdzanie, czy Usługi Google Play dla AR są zainstalowane

Przed utworzeniem sesji ARCore aplikacje zarówno wymagane przez AR, jak i opcjonalne w rzeczywistości rozszerzonej muszą wywołać metodę ArCoreApk.requestInstall(), by sprawdzić, czy zainstalowana jest zgodna wersja Usług Google Play dla AR, i upewnić się, że wszystkie wymagane dane profilu ARCore zostały pobrane.

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

Poproś o dostęp do aparatu

Zarówno aplikacje opcjonalne, jak i AR AR muszą zapewnić dostęp do aparatu przed utworzeniem sesji AR.

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

  …
}

Aktywność AR musi obejmować również: onRequestPermissionsResult().

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

Przestrzeganie wymagań dotyczących prywatności użytkowników

Aby opublikować aplikację w Sklepie Play, upewnij się, że jest ona zgodna z wymaganiami dotyczącymi prywatności użytkownika ARCore.

Co dalej?

• Dowiedz się, jak skonfigurować sesję ARCore.