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 等）裝置上使用時，需要使用 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 播放器設定中設定的套件名稱，建構過程將會失敗。若需使用其他地方設定的 license key，或需在 Unity 建構過程後修改套件名稱，可關閉此選項。

Lib variants

EasyAR Sense 庫變種配置。

EasyAR Sense License

EasyAR Sense License 相關設定。

LicenseKey

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

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

附註

在頭戴式顯示裝置（Vision Pro、XREAL、Pico、Rokid 等）裝置上使用時，需要使用 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 播放器設定中設定的套件名稱，建構過程將會失敗。若需使用其他地方設定的 license key，或需在 Unity 建構過程後修改套件名稱，可關閉此選項。

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 功能配置。

InertialCameraDevice support

唯讀選項，顯示當前配置下慣導功能是否可用以及 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 執行時。僅在 Lib Variant 為 Full 時有效。

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

Workaround for unity

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

Generatexmldoc

在腳本重新載入時產生 XML 文件，使 API 文件的 intelliSense 能夠運作。

Urp17rg_dx11_ruinedscene

解決 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 未來版本的發布日誌。