Class XREALFrameSource
- 命名空間
- easyar
- 組件
- EasyAR.Sense.dll
在場景中控制XREAL相機設備（easyar.XREALCameraDevice）的MonoBehaviour，在Unity環境下提供功能擴展。
這個frame source是一種運動追蹤設備，在ARSession中會輸出運動數據。
在自訂相機或頭顯上使用試用產品（個人版license、試用版XR-license或試用版Mega服務等）時，EasyAR Sense每次啟動後會在固定的有限時間內停止回應。
public class XREALFrameSource : FrameSource- 繼承
-
XREALFrameSource
屬性
AvailableCenterMode
僅當建立一個新的frame source時提供。它僅會在Assemble()過程中被訪問。
所有可以使用的中心模式。
protected override IReadOnlyList<ARSession.ARCenterMode> AvailableCenterMode { get; }Camera
僅當建立一個新的frame source時提供。它僅會在Assemble()過程中被訪問。
在桌面設備或手機上，該相機代表現實環境中相機設備在虛擬世界中對應的Camera，其投影矩陣和位置都將與真實相機對應，受EasyAR控制。在頭顯上，該相機僅用於將一些診斷文字展示在眼前，不用於畫面渲染，相機也不受EasyAR控制。
protected override Camera Camera { get; }CameraFrameStarted
僅當建立一個新的frame source時提供。它會在ARSession的整個生命週期內被訪問。
相機幀是否開始輸入。
protected override bool CameraFrameStarted { get; }DeviceCameras
僅當建立一個新的frame source時提供。它會在CameraFrameStarted為true時被訪問。
提供相機幀數據的設備相機。如果相機幀數據由多個相機提供，清單中需要包含所有相機。
確保在CameraFrameStarted為true時數值正確。
protected override List<FrameSourceCamera> DeviceCameras { get; }Display
僅當建立一個新的frame source時提供。它僅會在Assemble()過程中被訪問。
提供顯示系統資訊。你可以使用DefaultSystemDisplay或DefaultHMDDisplay來取得預設的顯示資訊。
protected override IDisplay Display { get; }FrameRate
幀率範圍。僅在Opened為true時可用。
public double FrameRate { get; }IsAvailable
僅當建立一個新的frame source時提供。它僅會在Assemble()過程中被訪問。
目前frame source是否可用。
如果數值等於null，CheckAvailability()會被呼叫，數值將在Coroutine結束後取得。
protected override Optional<bool> IsAvailable { get; }IsCameraUnderControl
僅當建立一個新的frame source時提供。它僅會在Assemble()過程中被訪問。
當值為ture時，session會更新相機的transform，且會渲染相機圖像。
在建立頭顯擴展時，它應為false。你應該完全控制場景中的3D相機。你應該處理相機渲染，尤其是在VST模式下。
protected override bool IsCameraUnderControl { get; }IsHMD
僅當建立一個新的frame source時提供。它僅會在Assemble()過程中被訪問。
目前frame source是否是頭顯。如果是頭顯，診斷資訊將顯示在相機前的3D板子上。
部分frame filter在設備上運行會有不同。
protected override bool IsHMD { get; }Opened
相機是否開啟。
public bool Opened { get; }ReceivedFrameCount
獲取到的幀計數。通常在debug中使用。如果這個數值停止增長，通常是硬體問題，重新插拔可能能解決。
public int ReceivedFrameCount { get; }Size
目前圖像大小。僅在Opened為true時可用。
public Vector2Int Size { get; }方法
CheckAvailability()
僅當建立一個新的frame source時提供。它僅會在Assemble()過程中被訪問。
IsAvailable等於null時用於檢查frame source是否可用的Coroutine。
protected override IEnumerator CheckAvailability()Close()
關閉設備。
public void Close()OnSessionStart(ARSession)
僅當建立一個新的frame source時提供。它僅會在StartSession()過程中被訪問。
處理session啟動，如果這個frame source已經組裝進Assembly。這個方法設計上是用來做延遲初始化的，你可以在這個方法中做AR獨有的初始化工作。
protected override void OnSessionStart(ARSession session)參數
session
OnSessionStop()
僅當建立一個新的frame source時提供。它會在StopSession(bool)或其它session停止/損壞過程中被訪問。
處理session停止，如果這個frame source已經組裝進Assembly。你可以使用這個方法銷毀StartSession()以及session運行中建立的資源並恢復內部狀態。在session銷毀之前這個方法會被保證呼叫。如果frame source在sessino之前銷毀，它將不會被呼叫，且session將損壞。
protected override void OnSessionStop()Open()
public void Open()事件
DeviceClosed
設備關閉的事件。
public event Action DeviceClosedDeviceOpened
設備開啟的事件，bool值表示是否成功。
public event Action<bool, PermissionStatus, string> DeviceOpened