Attivare l'AR nell'app Android

Attiva l'AR per usare le funzionalità di realtà aumentata nella tua app nuova o esistente.

Configurare l'app come AR richiesta o AR facoltativa

Per risparmiare spazio sui singoli dispositivi, tutte le funzionalità AR vengono memorizzate in un'app chiamata Google Play Services per AR che viene aggiornata separatamente dal Play Store. Le app per Android che utilizzano funzionalità AR comunicano con Google Play Services per AR tramite l'SDK ARCore. Un'app che supporta le funzionalità AR può essere configurata in due modi: AR obbligatorio e AR facoltativo. Questa designazione determina il modo in cui l'app interagisce con Google Play Services per l'app AR.

Un'app richiesta AR non può funzionare senza ARCore. Richiede un dispositivo supportato da ARCore su cui sia installato Google Play Services per AR.

  • Il Google Play Store renderà disponibili soltanto le app richieste AR sui dispositivi che supportano ARCore.
  • Quando gli utenti installano un'app richiesta in AR, il Google Play Store installa automaticamente Google Play Services per AR sul loro dispositivo. Tuttavia, la tua app deve comunque eseguire controlli di runtime aggiuntivi nel caso in cui Google Play Services per AR non sia aggiornato o sia stata disinstallata manualmente.

Un'app AR Facoltativo utilizza ARCore per migliorare le funzionalità esistenti. Dispone di funzionalità AR facoltative che vengono attivate soltanto sui dispositivi supportati da ARCore su cui è installato Google Play Services per AR.

  • Le app AR facoltative possono essere installate ed eseguite su dispositivi che non supportano ARCore.
  • Quando gli utenti installano un'app AR facoltativa, il Google Play Store non installa automaticamente Google Play Services per AR sul dispositivo.
AR richiestaAR (facoltativa)
Utilizzo di funzionalità AR La tua app richiede ARCore per le funzionalità di base. ARCore potenzia la funzionalità della tua app. L'app può essere eseguita senza il supporto ARCore.
Visibilità sul Play Store L'app è elencata nel Play Store soltanto sui dispositivi che supportano ARCore. L'app segue le normali procedure di creazione delle schede.
Metodo di installazione di Google Play Services per AR Il Play Store installa Google Play Services per AR insieme alla tua app. L'app utilizza ArCoreApk.requestInstall() per scaricare e installare ARCore.
Requisiti minSdkVersion per Android Android 7.0 (livello API 24) Android 7.0 (livello API 24)
Devi utilizzare ArCoreApk.checkAvailability() o ArCoreApk.checkAvailabilityAsync() per controllare il supporto di ARCore e lo stato dell'installazione
Devi utilizzare ArCoreApk.requestInstall() per installare Google Play Services per AR

Per rendere l'app richiesta AR o AR facoltativa, aggiorna AndroidManifest.xml in modo da includere le seguenti voci:

AR richiesta

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

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

Dopodiché modifica il valore build.gradle dell'app per specificare un valore minSdkVersion pari ad almeno 24:

 android {
     defaultConfig {
         …
         minSdkVersion 24
     }
 }

Aggiungi dipendenze di build

Per aggiungere ARCore al tuo progetto Android Studio:

  1. Assicurati che il file build.gradle del tuo progetto includa il Repository Maven di Google.

    allprojects {
        repositories {
            google()
            …
        }
    }
    
  2. Aggiungi la libreria ARCore più recente come dipendenza nel file build.gradle dell'app.

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

Esegui controlli di runtime

Durante il runtime, esegui le operazioni seguenti per assicurarti che le funzionalità AR dell'app funzionino senza problemi.

Verificare se ARCore è supportato

Sia le app AR richiesta sia le app AR facoltative devono utilizzare ArCoreApk.checkAvailability() o ArCoreApk.checkAvailabilityAsync() per stabilire se il dispositivo attuale supporta ARCore. Sui dispositivi che non supportano ARCore, le app devono disattivare le funzionalità relative all'AR e nascondere gli elementi UI associati.

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);
    }
  });
}
Anche se Google Play Services per AR è installato insieme all'app richiesta in AR, gli utenti con dispositivi non supportati potrebbero installarla da una fonte esterna. L'utilizzo di ArCoreApk.checkAvailability() o ArCoreApk.checkAvailabilityAsync() per verificare il supporto di ARCore garantisce un'esperienza coerente.

ArCoreApk.checkAvailability() potrebbe dover eseguire query sulle risorse di rete per determinare se il dispositivo supporta ARCore. Durante questo periodo, verrà restituito il valore UNKNOWN_CHECKING. Per ridurre la latenza percepita e il pop-in, le app devono chiamare ArCoreApk.checkAvailability() una volta all'inizio del suo ciclo di vita per avviare la query, ignorando il valore restituito. In questo modo, un risultato memorizzato nella cache sarà disponibile immediatamente quando potrebbe essere visualizzato un elemento UI che entra in AR.

Verificare se Google Play Services per AR è installato

Entrambe le app AR richiesta e AR facoltative devono chiamare ArCoreApk.requestInstall() prima di creare una sessione ARCore per verificare se è ancora installata una versione compatibile di Google Play Services per AR e per verificare che tutti i dati del profilo del dispositivo ARCore richiesti siano stati scaricati.

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

Richiedi autorizzazione di accesso alla fotocamera

Prima di creare una sessione AR, entrambe le app AR Facoltativo e AR Richiesto devono assicurarsi che sia stata concessa l'autorizzazione di accesso alla fotocamera.

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

  …
}

L'attività AR deve implementare anche 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();
  }
}

Rispettare i requisiti di privacy dell'utente

Per pubblicare la tua app sul Play Store, assicurati che sia conforme ai requisiti per la privacy degli utenti di ARCore.

Passaggio successivo