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 AR lub opcjonalnej AR

Aby oszczędzać 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ę obsługującą funkcje AR można skonfigurować na 2 sposoby: Wymagana rzeczywistość rozszerzona i 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 to urządzenia obsługującego ARCore, na którym zainstalowano Usługi Google Play dla AR.

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

Aplikacja opcjonalna AR używa ARCore do ulepszania 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 AR 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.

Aby włączyć w aplikacji AR jako wymagane lub opcjonalne, zaktualizuj AndroidManifest.xml, dodając 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ć minSdkVersion o wartości co najmniej 24:

 android {
     defaultConfig {
         …
         minSdkVersion 24
     }
 }

Dodaj zależności kompilacji

Aby dodać ARCore do projektu Android Studio:

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 środowiska wykonawczego

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

Sprawdzanie obsługi ARCore

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ć zapytanie ArCoreApk.checkAvailability() o zasoby sieciowe. W tym czasie zostanie zwrócona UNKNOWN_CHECKING. Aby zmniejszyć postrzegane opóźnienia i wyskakujące okienko, aplikacje powinny na początku cyklu życia wywoływać metodę ArCoreApk.checkAvailability() w celu zainicjowania zapytania, ignorując zwróconą wartość. Dzięki temu wynik z pamięci podręcznej będzie dostępny od razu, gdy pojawi się element interfejsu wywołujący AR.

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

Zarówno aplikacje wymagane, jak i opcjonalne AR muszą użyć atrybutu ArCoreApk.requestInstall() przed utworzeniem sesji ARCore, aby sprawdzić, czy jest (nadal) zainstalowana zgodna wersja Usług Google Play dla AR i czy upewnić się, że wszystkie wymagane dane z 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 uprawnienia do korzystania z aparatu

Przed utworzeniem sesji AR aplikacje opcjonalne AR i wymagające AR muszą mieć przyznane uprawnienia do korzystania z aparatu.

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

  …
}

Twoja aktywność AR musi też implementować komponent 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();
  }
}

Przestrzegaj 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żytkowników określonymi przez ARCore.

Co dalej

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