Table of Contents

EasyAR 配置

EasyAR 配置頁面可以從 Unity 菜單 EasyAR > Sense > Configuration 或 Edit > Project Settings > EasyAR 進入。

alt text

這裏包含所有對 EasyAR Sense Unity Plugin 的全局配置

alt text

Initialize On Startup

在啓動時初始化 EasyAR。通常建議保持這個選項打開。

如果關閉該選項，需要手動初始化 EasyAR Sense，具體方法可以參考 初始化 EasyAR Sense 。

EasyAR Sense License

EasyAR Sense License 相關配置。

LicenseKey

EasyAR Sense License Key。使用 EasyAR 功能必須填寫可用的 license。

僅當使用接口手動初始化 EasyAR Sense 時可留空。

附註

在頭顯設備（Vision Pro、XREAL、Pico、Rokid、Meta Quest 等）設備上使用時，需要使用 EasyAR XR License。

附註

在自定義相機或頭顯上使用試用產品（個人版 license、試用版 XR license 或試用版 Mega 服務等）時，EasyAR Sense 每次啓動後會在 100 秒（Mega 用戶可經由 EasyAR 商務在審批後調整時間長度）後停止響應。使用付費版本的 EasyAR Sense 和付費的 EasyAR Mega 服務沒有這個限制。

Verify When Build

在構建 Unity 工程時驗證 license Key。

當這個選項打開時，Unity 項目構建過程會驗證 license Key，如果 license 在構建平臺上無效或不包含 Unity Player Settings 中設置的包名，構建過程將會失敗。如果需要使用其它地方配置的 license key 或者需要在 Unity 構建過程之後修改包名，可以關閉這個選項。

Lib Variants

EasyAR Sense 庫變種配置。

僅 Android、iOS、visionOS 平臺可以選擇，Windows、Mac 平臺不支持選擇，始終使用 Full 變種。

EasyAR Sense 通常有多種變種，其不同變種的功能有差異。這裏列出插件中集成的庫變種對比。

Variant EasyAR Sense 變種名稱 功能差異 其它特殊性
Normal Community/Enterprise 不含錄屏、慣導及 Mega Go
Full CommunityFull/EnterpriseFull 包含慣導及 Mega Go 庫文件體積較大
VideoRecording CommunityR 包含錄屏功能（僅 Android）
提示

一些 Unity 中無法使用的變種未列入在內，比如 iOS 的 CommunityR 變種。

默認值：

  • 未導入 EasyAR Mega 支持包：Normal
  • 導入 EasyAR Mega 支持包：Full

推薦配置：

  • Full ：使用 EasyAR Mega 或使用慣導功能
  • Normal ：追求最小的包體大小，且不使用 EasyAR Mega 或慣導支持
  • VideoRecording ：需要使用錄屏功能（僅限 Android）

Permissions

應用權限配置。通常建議保持默認。

除相機權限外，其它權限配置不可更改，由其它功能配置所決定。

權限 是否可改 啓用條件 權限說明
Camera 是 相機權限，使用相機設備需要的權限
AndroidMicrophone 否 Variant 爲 VideoRecording 麥克風權限，使用錄屏功能需要的權限
Location 否 導入 Mega 支持包 （fine）定位權限，使用 EasyAR Mega 需要的權限

Unity XR

Unity XR 框架（AR Foundation 等）相關配置。

AR Foundation Support

AR Foundation 支持開關，建議保持打開。

在極個別情況下，比如需要使用 AR Foundation 4 或 AR Foundation 更新導致編譯出錯，可以關閉這個選項，但插件內所有與 AR Foundation 相關的功能將同時禁用。

附註

修改此選項之後腳本會自動重新編譯。

Unity XR Auto Switch

自動切換 Unity XR（比如 AR Foundation）物體的功能配置。

  • Editor ：編輯模式選項
    • Disable AR Session ：存在 ARSession 時，編輯時禁用 AR Foundation 的 ARSession。
  • Player ：運行模式選項
    • Enable ：啓用運行時控制。注意：關閉該選項，編輯模式被禁用的組件在運行時不會被恢復。
    • Enable If Desktop ：在 Windows/Mac 上啓用。
    • Enable If Mobile AR On Startup ：切換器啓動時，如果移動 AR（ARKit/ARCore）的 loader 是激活的，則啓用。通常這個選項需要 XR Plug-in Management 中的 Initialize XR on Startup 是選中的。
    • Disable If Non Mobile AR Post Startup ：切換器啓動時，如果存在移動 AR（ARKit/ARCore）之外的其它 loader，但沒有任何一個 loader 是激活的，則禁用。通常這個選項會在 XR Plug-in Management 中的 Initialize XR on Startup 未選中時被使用。
    • Restore AR Session When Disabled ：功能禁用時，恢復（啓用）所有被禁用的 AR Foundation 的 ARSession（無論它是否由 EasyAR 所禁用）。這個選項通常用於恢復編輯時被禁用的組件。

詳細功能說明可參考 Unity XR 自動切換 。

Mega

EasyAR Mega 功能配置。

Mega Block/Landmark Support

是否啓用 Mega Block/Landmark 支持。

該選項在導入 com.easyar.mega 後會默認開啓，未導入時默認關閉。

Mega Go Support

版本 >= 4003.1

是否啓用 Mega Go 端側定位支持。

只讀選項，顯示當前配置下 Mega Go 功能是否可用。

如果顯示信息不符合需求，需要視情況修改 Lib Variants 選項。

InertialCameraDevice Support

只讀選項，顯示當前配置下慣導功能是否可用。

如果顯示信息不符合需求，需要視情況修改 Lib Variants 選項。

ONNX Rumtime

只讀選項，顯示當前配置下 ONNX 運行時信息。

如果顯示信息不符合需求，需要視情況修改 Lib Variants 以及 ONNX Runtime (Bundled) 選項。

Mega Block > Localization Service Access [Global]

全局 Mega Block 定位服務器配置。

Mega Landmark > Localization Service Access [Global]

全局 Mega Landmark 定位服務器配置。

Spatial Map

EasyAR 空間地圖功能配置。

Service Access [Global]

全局稀疏地圖服務器配置。

Image Tracking

EasyAR 圖像跟蹤功能配置。

Target Gizmo

編輯器下 ImageTarget 的 Gizmos 配置。

打開這些選項將會在 Unity Editor 中顯示對應 gizmo，如果場景中該類 target 過多，可能會影響編輯器中的啓動性能。在設備上運行時的性能不會受到影響。

Cloud Recognition (CRS) > Service Access [Global]

全局雲識別服務器配置。

Object Tracking

EasyAR 物體跟蹤功能配置。

Target Gizmo

編輯器下 ObjectTarget 的 Gizmos 配置。

  • Enable：開啓 Gizmos。

Third-Party Libraries

第三方庫配置。

ARCore SDK

ARCore SDK 配置。

ARCore 提供了在部分 Android 設備上的運動跟蹤能力，可以閱讀 運動跟蹤與 EasyAR 功能 來了解 EasyAR 功能與運動跟蹤的關係，以及是否需要和什麼時候需要使用 ARCore。

  • AR Foundation Or Optional: 隨 EasyAR 或 AR Foundation 一起分發的 ARCore SDK 將會被包含在應用中，根據 ARCore XR Plugin 的設置決定。一般情況下推薦使用這個選項，它會自動處理 AR Foundation 的情況。
  • Optional: ARCore 功能在支持 ARCore 並安裝了 Google Play Services for AR 的設備上可以使用。
  • Required: 應用將只能在支持 ARCore 並安裝了 Google Play Services for AR 的設備上運行。
  • External: 如果在使用 AR Foundation 或其它 ARCore SDK 分發，可以使用這個選項。這樣隨 EasyAR 一起分發的 ARCore SDK 將不會使用。也可以使用這個選項來完全排除 ARCore SDK 在應用中的使用。
注意

如果把 ARCore SDK 設置爲 Required，或是在 AR Foundation 的 ARCore 配置中將 Requirement 設置爲 Required，並在不支持 ARCore 的設備上安裝了打包後的應用，設備會錯誤地報告 ARCore 是可用的並以 ARCore 運行。這會造成一個假象，似乎這些設備正在運行 ARCore 並且運行不正常（黑屏或其它異常情況），但這是錯誤的。

出現這個現象的原因是由於 Google Play 商店阻止在不受支持的設備上安裝標記 ARCore 爲必需的應用，所以這些應用總是假設它們正在受支持的設備上運行。

正常配置下，這些設備會在 session 組裝時判斷 ARCore 不受支持並使用 EasyAR 的功能。

關於 Optional 和 Required 的詳細說明及上線 Google Play Store 應用需要做的其它配置可以參考 Google 的說明（中國大陸，國際）。

附註

在 EasyAR Sense Unity Plugin 中，ARCore 的支持所需的庫文件和配置已經在插件包中，但要在手機上運行，仍需在手機上安裝 Google Play Services for AR 。

有三種不同來源的 ARCore SDK 可以使用：

  • 使用隨插件分發的 ARCore SDK

    插件內集成了一個 ARCore SDK 版本，詳細信息可以參考 ARCore、AR Engine 版本兼容性。在使用 EasyAR 的 ARCore 封裝時，可以不另外導入 AR Foundation。

  • 使用 AR Foundation 的 ARCore SDK

    如果需要使用 AR Foundation 的 ARCore SDK，可以參考 Google 的說明（中國大陸，國際）進行配置，這時 ARCore SDK 選項需要選擇 AR Foundation Or Optional 或 External 。

  • 使用其它 ARCore SDK

    如果有其它第三方插件或項目內有 ARCore SDK 的分發，也可以使用這些 ARCore SDK。這時 ARCore SDK 選項需要選擇 External ，並根據具體插件或項目的要求進行配置。

Warn 32-bit-only ARCore-enabled build

根據 Google 的說明，在 arm64 的設備上運行僅有 armv7 庫文件的程序，ARCore 不會正常工作。在打包時如果未選擇 ARM64 會彈出警告：

alt text

這時需要修改項目配置，使用 IL2CPP 編譯並選擇 ARM64 支持。

alt text

注意

如確有需要，可以選擇 Continue and don't warn me again，或者關閉該選項，這將關閉打包時的檢查。關閉檢查只是在打包時不彈出提示，但運行時在一些設備上將有可能出現異常，包括但不限於崩潰或黑屏等。

AR Engine SDK

AR Engine SDK 配置。

AR Engine 提供了在部分 Android 設備上的運動跟蹤能力，可以閱讀 運動跟蹤與 EasyAR 功能 來了解 EasyAR 功能與運動跟蹤的關係，以及是否需要和什麼時候需要使用 AR Engine。

  • AREngineInterop ：AREngineInterop 可用。隨 EasyAR 一起分發的 AR Engine SDK 將會被包含在應用中。
  • External ：AREngineInterop 可用。隨 EasyAR 一起分發的 AR Engine SDK 將不會使用。
  • Disabled ：AREngineInterop 不可用。隨 EasyAR 一起分發的 AR Engine SDK 將不會使用。所有與 AR Engine 有關的功能將被禁用。

ONNX Runtime (Bundled)

是否使用捆綁的 ONNX 運行時。

如需使用不同版本的 ONNX，可用從 ONNX 官方獲取更新版本並關閉該選項。使用自己編譯的二進制不兼容的 ONNX 將導致未知錯誤。

Workaround For Unity

針對 Unity bug 或不合理行爲的應對方案。

GenerateXMLDoc

在腳本重新加載時生成 XML 文檔，以使 API 文檔的 intelliSense 可以工作。

URP17RG_DX11_RuinedScene

Workaround URP 17 Render Graph DX11 場景渲染被毀損。Unity 6.2 及更新版本中該選項已關閉。

URP17RG_IOS_Glitches_Partial

部分規避 Unity Issue UUM-87787。

問題簡述：當從 EasyAR 獲取相機紋理（類似 ImageTracking_Coloring3D示例 及 ARSession 工作流（CameraDevice） 示例中的使用），在 iOS/Mac 設備上可以觀察到視覺故障和僞影。我們已經在純 Unity 包中復現該問題並報告給了 Unity： Glitches on iOS with AR Camera Image Rendering (URP 17 render graph) 。問題進展可以關注 Unity Issue UUM-87787 更新以及 Unity 未來版本的發佈日誌。