函数的用法
最高级别的 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
的可能结果,请参阅
错误代码
。