Włącz AR w aplikacji na Androida

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

Konfigurowanie aplikacji jako wymagającej lub opcjonalnej w zakresie AR

Aby zaoszczędzić miejsce na poszczególnych urządzeniach, wszystkie funkcje AR są przechowywane w aplikacji Usługi Google Play dla AR, która jest aktualizowana oddzielnie przez Sklep Play. Aplikacje na Androida, które korzystają z funkcji AR, komunikują się z Usługami Google Play dla AR za pomocą ARCore SDK. Aplikację obsługującą funkcje AR można skonfigurować na 2 sposoby: AR Required (AR wymagane) i AR Optional (AR opcjonalne). To oznaczenie określa, jak aplikacja do obsługi rzeczywistości rozszerzonej współpracuje z aplikacją Usługi Google Play dla AR.

Aplikacja wymagająca AR nie może działać bez ARCore. Wymaga to urządzenia obsługującego ARCore, na którym zainstalowane są Usługi Google Play dla AR.

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

Aplikacja AR Optional 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 AR Optional można instalować i uruchamiać na urządzeniach, które nie obsługują ARCore.
• Gdy użytkownicy zainstalują aplikację AR Optional, Sklep Google Play nie zainstaluje automatycznie na urządzeniu Usług Google Play dla AR.

	Wymagania dotyczące AR	AR Optional
Korzystanie z funkcji AR	Aplikacja wymaga ARCore do działania podstawowych funkcji.	ARCore rozszerza funkcjonalność aplikacji. Aplikacja może działać bez obsługi ARCore.
Widoczność w Sklepie Play	Twoja aplikacja jest dostępna w Sklepie Play tylko na urządzeniach obsługujących ARCore.	Aplikacja przechodzi zwykłą procedurę publikowania.
Metoda instalacji Usług Google Play dla AR	Sklep Play instaluje Usługi Google Play dla AR razem z aplikacją.	Aplikacja używa ArCoreApk.requestInstall() do pobierania i instalowania ARCore.
Wymagania dotyczące AndroidaminSdkVersion	Android 7.0 (poziom 24 interfejsu API)	Android 4.4 (interfejs API na poziomie 19), ale uruchomienie dowolnej funkcji AR wymaga co najmniej Androida 7.0 (interfejs API na poziomie 24).
Musisz użyć ArCoreApk.checkAvailability() lub ArCoreApk.checkAvailabilityAsync(), aby sprawdzić obsługę ARCore i stan instalacji.
Do instalacji Usług Google Play dla AR należy użyć ArCoreApk.requestInstall()

Aby ustawić aplikację jako wymagającą lub opcjonalną w zakresie AR, zaktualizuj plik AndroidManifest.xml, dodając te wpisy:

Wymagania dotyczące 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 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>

Następnie zmodyfikuj build.gradle aplikacji, aby określić minSdkVersion o wartości co najmniej 24:

 android {
     defaultConfig {
         …
         minSdkVersion 24
     }
 }

Dodawanie zależności kompilacji

Aby dodać ARCore do projektu w Android Studio:

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

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

Przeprowadzanie kontroli w czasie działania

Aby mieć pewność, że funkcje AR w aplikacji działają bezproblemowo, wykonaj te czynności w czasie działania aplikacji.

Sprawdzanie, czy ARCore jest obsługiwany

Aplikacje wymagające AR i aplikacje opcjonalnie korzystające z AR powinny używać funkcji ArCoreApk.checkAvailability() lub ArCoreApk.checkAvailabilityAsync(), aby sprawdzić, czy bieżące urządzenie obsługuje ARCore. Na urządzeniach, które nie obsługują ARCore, aplikacje powinny wyłączać funkcje związane z AR i ukrywać 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);
    }
  });
}

Usługi Google Play dla AR są instalowane razem z aplikacją wymagającą AR, ale użytkownicy urządzeń, które nie są obsługiwane, mogą zainstalować je z zewnętrznego źródła. Sprawdzanie obsługi ARCore za pomocą ArCoreApk.checkAvailability() lub ArCoreApk.checkAvailabilityAsync() zapewnia spójne wrażenia.

ArCoreApk.checkAvailability() może wysyłać zapytania do zasobów sieciowych, aby sprawdzić, czy urządzenie obsługuje ARCore. W tym czasie zwróci wartość UNKNOWN_CHECKING. Aby zmniejszyć odczuwalne opóźnienie i efekt pojawiania się, aplikacje powinny wywołać funkcję ArCoreApk.checkAvailability() raz na początku cyklu życia, aby zainicjować zapytanie, ignorując zwróconą wartość. Dzięki temu wynik zapisany w pamięci podręcznej będzie dostępny od razu, gdy może zostać wyświetlony element interfejsu wchodzenia do AR.

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

Zarówno aplikacje wymagające AR, jak i aplikacje z opcjonalną funkcją AR muszą przed utworzeniem sesji ARCore używać kodu ArCoreApk.requestInstall() , aby sprawdzić, czy zgodna wersja Usług Google Play dla AR jest (nadal) zainstalowana, i upewnić się, że wszystkie wymagane dane 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.
  }
  …
}

Prośba o uprawnienia dostępu do aparatu

W przypadku aplikacji AR Optional i AR Required przed utworzeniem sesji AR należy sprawdzić, czy przyznano uprawnienia dostępu do 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;
  }

  …
}

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

Zapewnij zgodność z wymaganiami dotyczącymi ochrony 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 ARCore.

Co dalej?

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