Class ARKitFrameSource
- 名前空間
- easyar
- アセンブリ
- EasyAR.Sense.dll
シーン内でARKitカメラデバイス（easyar.ARKitCameraDevice）を制御するMonoBehaviourで、Unity環境下での機能拡張を提供します。
このフレームソースはモーション追跡デバイスであり、ARSession内で運動データを出力します。
public class ARKitFrameSource : FrameSource- 継承
-
ARKitFrameSource
- 継承されたメンバー
フィールド
DesiredFocusMode
希望のフォーカスモード。DeviceOpenedイベントまたはOnEnable前に変更する必要があります。
注意：ハードウェアやシステムの制限により、一部デバイスではフォーカス切り替えが無効になる場合があります。
public ARKitCameraDeviceFocusMode DesiredFocusModeプロパティ
Camera
新しいフレームソースの作成時にのみ提供されます。Assemble()プロセス中のみアクセスされます。
デスクトップデバイスまたはモバイルデバイスでは、このカメラは現実世界のカメラデバイスに対応する仮想世界内のCameraを表し、その投影行列と位置は実カメラに対応し、EasyARによって制御されます。ヘッドマウントディスプレイでは、このカメラは目の前に診断テキストを表示するためだけに使用され、レンダリングには使用されず、カメラもEasyARによって制御されません。
protected override Camera Camera { get; }CameraCandidate
Cameraの代替。Unity XR Originを使用していない場合のみ有効です。未設定の場合はCamera.mainが使用されます。
public Camera CameraCandidate { get; set; }CameraFrameStarted
新しいフレームソースの作成時にのみ提供されます。ARSessionのライフサイクル全体を通じてアクセスされます。
カメラフレームの入力が開始されたかどうか。
protected override bool CameraFrameStarted { get; }DesiredFrameRate
希望のカメラ画像フレームレート。DeviceOpenedイベント前に変更する必要があります。
SupportedFrameRate内の値に最も近いサイズが使用されます。未設定の場合はデフォルト値が使用されます。
public Optional<double> DesiredFrameRate { get; set; }DesiredSize
希望のカメラ画像サイズ。DeviceOpenedイベント前に変更する必要があります。
SupportedSize内の値に最も近いサイズが使用されます。未設定の場合はデフォルト値が使用されます。
public Optional<Vector2Int> DesiredSize { get; set; }DeviceCameras
新しいフレームソースの作成時にのみ提供されます。CameraFrameStartedがtrueの場合にアクセスされます。
カメラフレームデータを提供するデバイスカメラ。カメラフレームデータが複数のカメラによって提供される場合、リストにはすべてのカメラを含める必要があります。
CameraFrameStartedがtrueの時に値が正しいことを確認してください。
protected override List<FrameSourceCamera> DeviceCameras { get; }Display
新しいフレームソースの作成時にのみ提供されます。Assemble()プロセス中のみアクセスされます。
表示システム情報を提供します。DefaultSystemDisplayまたはDefaultHMDDisplayを使用してデフォルトの表示情報を取得できます。
protected override IDisplay Display { get; }FrameRate
デバイスの現在のフレームレート。Openedがtrueの場合のみ利用可能です。
setすると、SupportedFrameRate内の値に最も近いサイズが使用されます。
public double FrameRate { get; set; }IsAvailable
新しいフレームソースの作成時にのみ提供されます。Assemble()プロセス中のみアクセスされます。
現在のフレームソースが利用可能かどうか。
値がnullの場合、CheckAvailability()が呼び出され、値はCoroutine終了後に取得されます。
protected override Optional<bool> IsAvailable { get; }IsCameraUnderControl
新しいフレームソースの作成時にのみ提供されます。Assemble()プロセス中のみアクセスされます。
値がtrueの場合、セッションはカメラのtransformを更新し、カメラ画像をレンダリングします。
ヘッドマウントディスプレイ拡張を作成する際、これはfalseに設定する必要があります。シーン内の3Dカメラを完全に制御する必要があります。特にVSTモードでは、カメラのレンダリングを処理する必要があります。
protected override bool IsCameraUnderControl { get; }IsHMD
新しいフレームソースの作成時にのみ提供されます。Assemble()プロセス中のみアクセスされます。
現在のフレームソースがヘッドマウントディスプレイかどうか。ヘッドマウントディスプレイの場合、診断情報はカメラの前の3Dパネルに表示されます。
一部のフレームフィルターはデバイス上で異なる動作をします。
protected override bool IsHMD { get; }Opened
カメラが開いているかどうか。
public bool Opened { get; }Size
現在の画像サイズ。Openedがtrueの場合のみ利用可能です。
setすると、SupportedSize内の値に最も近いサイズが使用されます。
FrameRecorderの録画中に画像サイズを変更した場合、録画データの更新が停止します。閉じてから再録画が必要です。
public Vector2Int Size { get; set; }SupportedFrameRate
現在のデバイスがサポートする全てのフレームレート。Openedがtrueの場合のみ利用可能です。
public List<double> SupportedFrameRate { get; }SupportedSize
現在のデバイスがサポートする全ての画像サイズ。Openedがtrueの場合のみ利用可能です。
public List<Vector2Int> SupportedSize { get; }enabled
ARSession実行時にビデオストリームデータの収集を開始/停止します。セッション起動後、MonoBehaviour.enabledがtrueの場合にのみ収集が開始されます。
public bool enabled { get; set; }メソッド
Close()
デバイスを閉じます。
public void Close()OnSessionStart(ARSession)
新しいフレームソースの作成時にのみ提供されます。StartSession()プロセス中のみアクセスされます。
このフレームソースがAssemblyに組み込まれている場合、セッションの起動を処理します。このメソッドは遅延初期化のために設計されており、このメソッド内でAR固有の初期化作業を行うことができます。
protected override void OnSessionStart(ARSession session)パラメーター
session
OnSessionStop()
新しいフレームソースの作成時にのみ提供されます。StopSession(bool)またはその他のセッション停止/破損プロセス中にアクセスされます。
このフレームソースがAssemblyに組み込まれている場合、セッションの停止を処理します。このメソッドを使用して、StartSession()およびセッション実行中に作成されたリソースを破棄し、内部状態を復元できます。セッション破棄前にこのメソッドは確実に呼び出されます。フレームソースがセッションより先に破棄される場合、このメソッドは呼び出されず、セッションは破損します。
protected override void OnSessionStop()Open()
public void Open()イベント
DeviceClosed
デバイスが閉じられたイベント。
public event Action DeviceClosedDeviceOpened
デバイスが開かれたイベントで、bool値は成功したかどうかを示します。
public event Action<bool, PermissionStatus, string> DeviceOpened