在 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 的裝置，並且安裝「Google Play 服務 - AR 適用」。

• Google Play 商店只會在支援 ARCore 的裝置上提供必要的 AR 應用程式。
• 當使用者安裝「需要 AR 規定」應用程式後，Google Play 商店就會自動在裝置上安裝「Google Play 服務 - AR 適用」服務。不過，假如 Google Play 服務 - AR 版本過舊或手動解除安裝，應用程式仍須執行額外的執行階段檢查。

AR 選用應用程式會利用 ARCore 強化現有功能。它具有選用的 AR 功能，只有在已安裝 Google Play 服務 - AR 支援的裝置上才支援 ARCore。

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

	需要 AR	AR (選用)
AR 功能使用情形	您的應用程式需要有 ARCore 才能使用基本功能。	ARCore 可強化應用程式的功能。您的應用程式可以在不支援 ARCore 的情況下執行。
Play 商店顯示設定	您的應用程式只會在支援 ARCore 的裝置上的 Play 商店上架。	您的應用程式符合正常商店資訊程序。
「Google Play 服務 - AR 適用」安裝方法	Play 商店會為您的應用程式一併安裝 Google Play 服務 - AR 適用服務。	您的應用程式會使用 ArCoreApk_requestInstall() 下載並安裝 ARCore。
Android minSdkVersion 需求條件	Android 7.0 (API 級別 24)	Android 7.0 (API 級別 24)
必須使用 ArCoreApk_checkAvailability() 或 ArCoreApk_checkAvailabilityAsync() 查看 ARCore 支援和安裝狀態
請務必使用 ArCoreApk_requestInstall() 安裝 Google Play 服務 - AR 適用

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

需要 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 (選用)

<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，指定至少 24 的 minSdkVersion：

 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

必要的 AR 和 AR 選用應用程式都應使用 ArCoreApk_checkAvailability() 或 ArCoreApk_checkAvailabilityAsync()，判斷目前裝置是否支援 ARCore。在不支援 ARCore 的裝置上，應用程式應停用 AR 相關功能並隱藏相關聯的 UI 元素。

Android NDK 應用程式可以使用 Java ArCoreApk 類別檢查相容性，並管理原生 C ARCore Session 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.
  }
}

雖然 Google Play 服務 - AR 專用服務是一併安裝「需要 AR 規定」的應用程式，但是如果裝置不受支援，使用者仍可能從外部來源安裝該應用程式。使用 ArCoreApk_checkAvailability() 或 ArCoreApk_checkAvailabilityAsync() 檢查 ARCore 支援，確保提供一致的體驗。

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

檢查是否已安裝 Google Play 服務 - AR 服務

必要和 AR 選用應用程式都必須呼叫 ArCoreApk_requestInstall()，才能建立 ARCore 工作階段，檢查是否已安裝相容版本的 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 工作階段。