Attivare l'AR nell'app Android NDK

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

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

    allprojects {
        repositories {
            google()
            …
        }
    }
    
  2. Aggiungi un'attività personalizzata al file build.gradle del tuo modulo per estrarre le librerie native incluse dal file ARCore AAR. In questo modo, è possibile farvi riferimento direttamente in un progetto C o C++.

  3. Nella directory app/build, definisci una variabile per la directory in cui verranno estratte le librerie native.

  4. Crea una configurazione Gradle per conservare i dati e le attività di estrazione.

    /*
    The ARCore AAR library contains native shared libraries that are
    extracted before building to a temporary directory.
    */
    def arcore_libpath = "${buildDir}/arcore-native"
    
    // Create a configuration to mark which aars to extract .so files from
    configurations { natives }
    
  5. Crea un'attività per copiare le librerie native dal file AAR e aggiungila alle dipendenze della build.

    // Extracts the shared libraries from AARs in the native configuration
    // so that NDK builds can access these libraries.
    task extractNativeLibraries() {
       // Extract every time.
       outputs.upToDateWhen { false }
    
       doFirst {
            configurations.natives.files.each { f ->
                copy {
                    from zipTree(f)
                    into arcore_libpath
                    include "jni/**/*"
                }
            }
        }
    }
    
    tasks.whenTaskAdded {
        task-> if (task.name.contains("external") && !task.name.contains("Clean")) {
            task.dependsOn(extractNativeLibraries)
        }
    }
    
  6. Configura i flag delle build native per passare le località agli strumenti di creazione esterni.

    // From the sample app.
    externalNativeBuild {
        cmake {
            cppFlags "-std=c++11", "-Wall"
            arguments "-DANDROID_STL=c++_static",
                    "-DARCORE_LIBPATH=${arcore_libpath}/jni",
                    "-DARCORE_INCLUDE=${project.rootDir}/../../libraries/include"
        }
    }
    
  7. Aggiungi le dipendenze per le librerie Java e native.

    dependencies {
         ...
         // Add Java and native dependencies to the ARCore library.
         implementation 'com.google.ar:core:1.33.0'
         natives 'com.google.ar:core:1.33.0'
         ...
    }
    
  8. Fai riferimento alle librerie native in CMakeLists.txt.

    # Import the ARCore library.
    add_library(arcore SHARED IMPORTED)
    set_target_properties(arcore PROPERTIES IMPORTED_LOCATION
                  ${ARCORE_LIBPATH}/${ANDROID_ABI}/libarcore_sdk_c.so
                  INTERFACE_INCLUDE_DIRECTORIES ${ARCORE_INCLUDE}
    )
    

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.

Un'app NDK per Android può utilizzare la classe ArCoreApk Java per verificare la compatibilità e gestire l'installazione nell'API C ARCore Session nativa. A seconda della struttura della tua app, potrebbe essere più semplice rispetto all'utilizzo delle funzioni di ArCoreApk_ a causa dell'elevato numero di operazioni di gestione degli errori e di interazione con l'interfaccia utente.

void maybeEnableArButton(JNIEnv env, jobject context) {
  // Likely called from Activity.onCreate() of an activity with AR buttons.
  ArAvailability availability
  ArCoreApk_checkAvailability(env, context, &availability);
  if (availability == AR_AVAILABILITY_UNKNOWN_CHECKING) {
    // Set a timer to call maybeEnableArButton() again after about 200ms.
  }
  if (availability == AR_AVAILABILITY_SUPPORTED_NOT_INSTALLED ||
      availability == AR_AVAILABILITY_SUPPORTED_APK_TOO_OLD ||
      availability == AR_AVAILABILITY_SUPPORTED_INSTALLED) {
    // Show or enable the AR button.
  } else {
    // Hide or disable the AR button.
  }
}
Anche se Google Play Services per AR è installato insieme all'app richiesta 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 AR_AVAILABILITY_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.

// Tracks if an installation request has already been triggered.
bool install_requested_;

void nativeOnCreate() {
  // Do other setup here.

  install_requested_ = false;
}

void nativeOnResume(JNIEnv env, jobject activity) {
  if (ar_session_ == null) {
    bool user_requested_install = !install_requested_;

    ArInstallStatus install_status;
    // Ensure that Google Play Services for AR and ARCore device profile data are
    // installed and up to date.
    ArStatus error = ArCoreApk_requestInstall(
        env, activity, user_requested_install, &install_status);
    if (error != AR_SUCCESS) {
      // Inform user of error.
      return;
    }

    switch (install_status) {
      case AR_INSTALL_STATUS_INSTALLED:
        break;
      case AR_INSTALL_STATUS_INSTALL_REQUESTED:
        // When this method returns AR_INSTALL_STATUS_INSTALL_REQUESTED:
        // 1. This activity will be paused.
        // 2. The user is prompted 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. This activity is resumed. The next invocation of
        //    ArCoreApk_requestInstall() will either return
        //    AR_INSTALL_STATUS_INSTALLED or throw an exception if the
        //    installation or update did not succeed.
        install_requested_ = true;
        return;
    }

    // Request camera permissions.

    error = ArSession_create(env, context, &ar_session_);
    if (error != AR_SUCCESS) {
      // Inform user of error.
      return;
    }

    // Configure the ARCore session.
  }

  // Normal onResume behavior.
}

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