在 Android NDK 應用程式中啟用 AR

只要啟用 AR，即可在新的或現有應用程式中使用擴增實境功能。

將應用程式設為「必須使用 AR」或「選用 AR」

為節省個別裝置的空間，所有 AR 功能都會儲存在名為「Google Play 服務 - AR 適用」的應用程式中，而該應用程式會由 Play 商店個別更新。使用 AR 功能的 Android 應用程式會透過 ARCore SDK 與 Google Play 服務 - AR 通訊。支援 AR 功能的應用程式可透過兩種方式進行設定：必需使用 AR和選用 AR。這項指定會決定應用程式與 Google Play 服務 - AR 適用應用程式的互動方式。

必要 AR 版本應用程式無法在沒有 ARCore 的情況下運作。必須使用支援 ARCore 的裝置，且裝置必須安裝 AR 適用的 Google Play 服務。

• Google Play 商店只會在支援 ARCore 的裝置上提供採用 AR 所需的應用程式。
• 使用者安裝 AR 所需應用程式後，Google Play 商店會自動在他們的裝置上安裝「Google Play 服務 - AR 適用」。不過，如果 AR 適用的 Google Play 服務版本過舊或已手動解除安裝，您的應用程式仍須執行其他執行階段檢查。

AR 選用應用程式會使用 ARCore 強化現有功能。這項服務提供選用的 AR 功能，但只有在已安裝 Google Play 服務 - AR 適用的 ARCore 支援裝置上才能啟用。

• 可在不支援 ARCore 的裝置上安裝及執行 AR 選用應用程式。
• 當使用者安裝 AR 選用應用程式時，Google Play 商店不會在裝置上自動安裝 Google Play 服務 - AR 適用。

如要將應用程式設為 AR 必要或 AR 選用，請更新 AndroidManifest.xml 加入下列項目：

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

接著，修改應用程式的 build.gradle，指定 minSdkVersion 至少為 24：

 android {
     defaultConfig {
         …
         minSdkVersion 24
     }
 }

新增建構依附元件

1. 請確認專案的 build.gradle 檔案包含 Google 的 Maven 存放區。

   allprojects {
       repositories {
           google()
           …
       }
   }
   

2. 請在模組的 build.gradle 檔案中新增自訂工作，從 ARCore AAR 檔案中擷取所附帶的原生程式庫。如此一來，就可以在 C 或 C++ 專案中直接參照這些變數。

3. 在 app/build 目錄中，將變數定義為原生程式庫的解壓目錄。

4. 建立 Gradle 設定，用於存放資料和擷取工作。

   /*
   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. 建立工作，從 AAR 檔案複製原生程式庫，然後將其新增至建構依附元件。

   // 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. 設定原生建構旗標，將位置傳送至外部建構工具。

   // 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. 新增 Java 和原生程式庫的依附元件。

   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. 參考 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}
   )
   

執行執行階段檢查

在執行階段期間，請執行下列操作，確保應用程式中的 AR 功能順利執行。

檢查系統是否支援 ARCore

Android NDK 應用程式可能會使用 Java ArCoreApk 類別，在原生 C ARCore 工作階段 API 中檢查相容性，並管理安裝作業。視應用程式的結構而定，這種做法可能會比使用 ArCoreApk_ 函式更容易，因為涉及大量錯誤處理和使用者介面互動。

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

ArCoreApk_checkAvailability() 可能需要查詢網路資源，以判斷裝置是否支援 ARCore。在這段期間，它會傳回 AR_AVAILABILITY_UNKNOWN_CHECKING。為減少延遲和彈出情形，應用程式應在生命週期初期呼叫 ArCoreApk_checkAvailability()，以便啟動查詢，並忽略傳回的值。這樣一來，系統就能在 AR 進入 UI 元素時顯示快取結果。

檢查是否已安裝「Google Play 服務 - AR 適用」

無論是 AR 必備應用程式還是 AR 選用應用程式，都必須在建立 ARCore 工作階段前使用 ArCoreApk.requestInstall() ，以便檢查是否 (仍) 安裝相容版本的 Google Play 服務 - AR 適用，並確保已下載所有必要的 ARCore 裝置設定檔資料。

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

遵守使用者隱私權規定

如要在 Play 商店中發布應用程式，請確認您的應用程式符合 ARCore 的 使用者隱私權規定。

後續步驟

• 瞭解如何設定 ARCore 工作階段。