函數的用法
頂級 API 提供以下廣域的函數:
Init()
int Init(StatusCallback callback, string viveportId)
名稱 | 類型 | 描述 |
callback | StatusCallback | |
viveportId | string | VIVEPORT ID |
回傳:
int
。值為
1
代表函數已完成且沒有錯誤。
初始化 VIVEPORT SDK 並分配資源 (例如記憶體)。在調用 VIVEPORT SDK 中的任何其他 API 前,此函數必須成功回傳。
Shutdown()
int Shutdown(StatusCallback callback);
名稱 | 類型 | 描述 |
callback | StatusCallback |
回傳:
int
。值為
1
代表函數已完成且沒有錯誤。
關閉 SDK,並且在不再需要時釋放資源。
Version()
string Version();
回傳:
string
。回傳客戶端 SDK 目前的版本。
QueryRuntimeMode()
void QueryRuntimeMode(QueryRunTimeHandler);
從
QueryRuntimeHandler()
調用函數中取得執行階段資訊,以確認正在使用哪個 VIVEPORT 平台。
QueryRunTimeHandler()
delegate void QueryRunTimeHandler(int nResult, int nMode);
透過此回調函數,確認 VR 內容適用於哪個 VIVEPORT 平台。
初始化成功時,此回調函數的
nResult
將回傳
0
;初始化失敗時將回傳
1
。
當目標平台是 VIVEPORT Desktop 時,
nMode
將回傳
1
;目標平台是 VIVEPORT Arcade 時,
nMode
將回傳
2
。
注意:
切換至 VIVEPORT Arcade 模式後,即可使用 VIVEPORT Arcade API。更多詳細資訊,請參閱
模擬街機環境
。
Callback: StatusCallback()
public delegate void StatusCallback(int nResult);
名稱 | 類型 | 描述 |
nResult | int | Result code |
關於
nResult
的可能結果,請參閱
錯誤代碼
。