Włącz AR w aplikacji na Androida

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

Konfigurowanie aplikacji jako wymaganej lub opcjonalnej AR

Aby zaoszczędzić miejsce na poszczególnych urządzeniach, wszystkie funkcje AR są przechowywane w aplikacji o nazwie Usługi Google Play dla AR, która jest aktualizowana oddzielnie przez Sklep Play. Aplikacje na Androida, które używają funkcji AR, komunikują się z Usługami Google Play dla AR za pomocą pakietu SDK ARCore. Aplikację, która obsługuje funkcje AR, można skonfigurować na 2 sposoby: Wymagana rzeczywistość rozszerzona i opcjonalna AR. 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 ARCore, na którym są zainstalowane Usługi Google Play dla AR.

  • Sklep Google Play udostępnia aplikacje wymagane w rzeczywistości rozszerzonej tylko na urządzeniach, które obsługują ARCore.
  • Gdy użytkownicy zainstalują aplikację wymagającą AR, Sklep Google Play automatycznie zainstaluje Usługi Google Play dla AR na ich urządzeniach. Aplikacja nadal musi jednak przeprowadzać dodatkowe kontrole w czasie działania na wypadek, gdyby Usługi Google Play dla AR były nieaktualne lub zostały odinstalowane ręcznie.

Aplikacja opcjonalna AR używa ARCore do ulepszenia dotychczasowych funkcji. Zawiera opcjonalne funkcje AR, które są aktywowane tylko na urządzeniach obsługujących ARCore, na których zainstalowano Usługi Google Play dla AR.

  • Aplikacje opcjonalne w rzeczywistości rozszerzonej można instalować i uruchamiać na urządzeniach, które nie obsługują ARCore.
  • Gdy użytkownicy zainstalują aplikację opcjonalną AR, Sklep Google Play nie zainstaluje automatycznie Usług Google Play dla AR na urządzeniu.
Wymagana jest ARAR (opcjonalnie)
Wykorzystanie funkcji AR Twoja aplikacja potrzebuje ARCore do obsługi podstawowych funkcji. ARCore zwiększa funkcjonalność Twojej aplikacji. Twoja aplikacja może działać bez obsługi ARCore.
Widoczność w Sklepie Play Aplikacja jest dostępna w Sklepie Play tylko na urządzeniach obsługujących ARCore. Aplikacja jest zgodna z standardowymi procedurami dotyczącymi zamieszczania informacji.
Metoda instalacji Usług Google Play dla AR Sklep Play instaluje Usługi Google Play dla AR obok Twojej aplikacji. Twoja aplikacja używa usługi ArCoreApk.requestInstall() do pobierania i instalowania ARCore.
Wymagania Androida minSdkVersion Android 7.0 (poziom API 24) Android 7.0 (poziom API 24)
Aby sprawdzić obsługę ARCore i stan instalacji, musisz użyć ArCoreApk.checkAvailability() lub ArCoreApk.checkAvailabilityAsync()
Aby zainstalować Usługi Google Play dla AR, musi używać ArCoreApk.requestInstall()

Aby funkcja AR w aplikacji była wymagana lub opcjonalna, zaktualizuj AndroidManifest.xml, podając te wpisy:

Wymagana jest AR

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

<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ć minSdkVersion o wartości co najmniej 24:

 android {
     defaultConfig {
         …
         minSdkVersion 24
     }
 }

Dodaj zależności kompilacji

Aby dodać ARCore do projektu Android Studio, wykonaj te czynności:

  1. Sprawdź, czy 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'
    }
    

Sprawdzanie w czasie działania

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

Sprawdzanie, czy ARCore jest obsługiwane

Aby określić, czy aktualnie używane urządzenie obsługuje ARCore, aplikacje wymagane w przypadku AR i opcjonalne AR powinny używać ArCoreApk.checkAvailability() lub ArCoreApk.checkAvailabilityAsync(). Na urządzeniach, które nie obsługują ARCore, aplikacje powinny wyłączyć funkcje AR i ukryć powiązane elementy interfejsu.

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);
    }
  });
}
Mimo że Usługi Google Play dla AR są zainstalowane razem z aplikacją wymaganą do AR, użytkownicy z nieobsługiwanych urządzeń mogą zainstalować ją ze źródła zewnętrznego. Spójność informacji możesz uzyskać, sprawdzając obsługę ARCore za pomocą ArCoreApk.checkAvailability() lub ArCoreApk.checkAvailabilityAsync().

Aby określić, czy urządzenie obsługuje ARCore, być może ArCoreApk.checkAvailability() będzie musiało wysłać zapytanie do zasobów sieciowych. W tym czasie zostanie zwrócona UNKNOWN_CHECKING. Aby zmniejszyć widoczne opóźnienie i wypytanie, aplikacje powinny wywoływać funkcję ArCoreApk.checkAvailability() raz na początku cyklu życia w celu zainicjowania zapytania, ignorując zwracaną wartość. Dzięki temu wynik z pamięci podręcznej będzie dostępny natychmiast po wyświetleniu elementu interfejsu użytkownika dostępnego w AR.

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

Przed utworzeniem sesji ARCore zarówno aplikacje wymagane, jak i opcjonalne AR muszą wywołać metodę ArCoreApk.requestInstall(), aby sprawdzić, czy zainstalowano (nadal) zgodną wersję Usług Google Play dla AR i upewnić się, że wszystkie wymagane dane z profilu urządzenia ARCore zostały pobrane.

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

Poproś o uprawnienia do korzystania z aparatu

Przed utworzeniem sesji AR zarówno opcjonalne aplikacje AR, jak i aplikacje wymagane przez AR muszą mieć przyznane uprawnienia do korzystania z aparatu.

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

  …
}

Twoja aktywność związana z AR musi też obejmować onRequestPermissionsResult().

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

Przestrzegaj wymagań dotyczących prywatności użytkownika

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

Co dalej?