XGameStreaming
初始化
初始化游戏流式处理功能所需的 API。| 函数 | 说明 |
|---|---|
| XGameStreamingInitialize | 初始化 Game Streaming API。 |
| XGameStreamingUninitialize | 取消初始化 Game Streaming API。 |
客户端属性
用于获取流式处理设备或其游戏流属性的 API函数
| 函数 | 说明 |
|---|---|
| XGameStreamingClientPropertiesChangedCallback | 当流式处理设备的属性发生变化时发出通知。 |
| XGameStreamingGetClientIPAddress | 已弃用。 获取流式处理客户端的 IP 地址。请改用 XSTS 令牌声明。 |
| XGameStreamingGetDisplayDetails | 获取流式处理客户端的显示详细信息。 |
| XGameStreamingGetSessionId | 获取流式处理客户端的会话 ID。 |
| XGameStreamingGetStreamPhysicalDimensions | 获取视频流当前在流式处理客户端上呈现的物理大小。 |
| XGameStreamingGetTouchBundleVersion | 获取指定设备上当前使用的触控适配捆绑包的版本。 |
| XGameStreamingGetTouchBundleVersionNameSize | 获取指定设备上触控适配捆绑包中指定版本名称的大小。 |
| XGameStreamingIsTouchInputEnabled | 检查客户端是否会向游戏发送触摸输入。 |
| XGameStreamingRegisterClientPropertiesChanged | 注册一个回调，当任何流式处理客户端设备的属性发生变化时调用该回调。 |
| XGameStreamingUnregisterClientPropertiesChanged | 取消注册先前注册的 XGameStreamingClientPropertiesChangedCallback。 |
枚举
| 枚举 | 说明 |
|---|---|
| XGameStreamingClientProperty | 可以查询的关于客户端流式处理设备的属性。 |
| XGameStreamingVideoFlags | 客户端流式处理设备可能支持的可用视频功能。 |
结构
| 结构 | 说明 |
|---|---|
| XGameStreamingDisplayDetails | 有关流式处理客户端设备显示的详细信息。 |
连接状态
管理流式处理客户端设备连接状态所需的 API。函数
| 函数 | 说明 |
|---|---|
| XGameStreamingConnectionStateChangedCallback | 每当已连接的流式处理客户端的状态发生变化时要调用的回调函数。 |
| XGameStreamingGetClientCount | 当前连接的流式处理设备的数量。 |
| XGameStreamingGetClients | 获取每个当前已连接客户端的标识符。 |
| XGameStreamingGetConnectionState | 获取指定设备的当前连接状态。 |
| XGameStreamingIsStreaming | 确定游戏当前是否正在流式处理。 |
| XGameStreamingRegisterConnectionStateChanged | 注册一个回调，当流式处理客户端设备的连接状态发生变化时调用该回调。 |
| XGameStreamingUnregisterConnectionStateChanged | 取消注册先前注册的 XGameStreamingConnectionStateChangedCallback。 |
枚举
| 枚举 | 说明 |
|---|---|
| XGameStreamingConnectionState | 流式处理客户端设备的连接状态。 |
延迟
用于针对流式处理延迟调整游戏玩法的 API。函数
| 函数 | 说明 |
|---|---|
| XGameStreamingGetStreamAddedLatency | 获取与流式处理相关的延迟的近期平均值。 |
| XGameStreamingGetLastFrameDisplayed | 已弃用。 获取最近显示在流式处理客户端屏幕上的帧的帧管道令牌。 |
| XGameStreamingGetAssociatedFrame | 已弃用。 从特定输入读取获取帧管道令牌。 |
服务器位置
用于访问游戏流式处理来源的位置的 API。函数
| 函数 | 说明 |
|---|---|
| XGameStreamingGetServerLocationName | 获取流式处理服务器的数据中心位置。 |
| XGameStreamingGetServerLocationNameSize | 获取流式处理服务器数据中心位置的名称大小 |
触控适配
用于管理将向相应流式处理客户端公开的触摸控制器布局的 API。函数
| 函数 | 说明 |
|---|---|
| XGameStreamingGetGamepadPhysicality | 从特定游戏手柄读取获取输入物理映射。 |
| XGameStreamingHideTouchControls | 请求所有已连接的流式处理客户端设备在触摸布局可见时将其隐藏。 |
| XGameStreamingHideTouchControlsOnClient | 请求指定的流式处理客户端设备在触摸布局可见时将其隐藏。 |
| XGameStreamingShowTouchControlLayout | 请求所有已连接的流式处理客户端设备显示指定的触摸布局。 |
| XGameStreamingShowTouchControlLayoutOnClient | 请求指定的已连接流式处理客户端设备显示指定的触摸布局。 |
| XGameStreamingShowTouchControlsWithStateUpdate | 请求所有已连接的流式处理客户端设备更新其触摸控件状态，然后显示指定的触摸布局。 |
| XGameStreamingShowTouchControlsWithStateUpdateOnClient | 请求指定的流式处理客户端设备更新其触摸控件状态，然后显示指定的触摸布局。 |
| XGameStreamingUpdateTouchControlsState | 更新所有已连接流式处理客户端设备上的触摸控件状态。 |
| XGameStreamingUpdateTouchControlsStateOnClient | 更新指定流式处理客户端设备上的触摸控件状态。 |
枚举
| 枚举 | 说明 |
|---|---|
| XGameStreamingGamepadPhysicality | 标准 XBOX 无线控制器上所有按钮、摇杆和扳机键的物理映射。对于任何给定的按钮/摇杆/扳机键，物理性可以是未知、物理、虚拟或两者兼具。 |
| XGameStreamingTouchControlsStateOperationKind | 更新触摸控件布局状态时可以采取的操作。 |
| XGameStreamingTouchControlsStateValueKind | 指定与触摸布局关联的状态的类型。 |
结构
| 结构 | 说明 |
|---|---|
| XGameStreamingTouchControlsStateOperation | 指定要应用的操作、特定变量的路径和值。 |
| XGameStreamingTouchControlsStateValue | 提供触摸控件状态的特定元素的类型和值。 |
分辨率
用于管理流分辨率的 API。函数
| 函数 | 说明 |
|---|---|
| XGameStreamingSetResolution | 设置视频流的分辨率。 |
错误代码
XGameStreaming API 可能返回以下错误代码。有关完整列表，请参阅错误代码。| 代码 | 值 | 说明 |
|---|---|---|
| E_GAMESTREAMING_NOT_INITIALIZED | 0x89245400 | XGameStreaming 运行时未初始化。在调用其他 API 之前，请先调用 XGameStreamingInitialize。 |
| E_GAMESTREAMING_CLIENT_NOT_CONNECTED | 0x89245401 | 指定的客户端未连接。 |
| E_GAMESTREAMING_NO_DATA | 0x89245402 | 请求的数据不可用。数据可能稍后可用。 |
| E_GAMESTREAMING_NO_DATACENTER | 0x89245403 | 当前计算机未在数据中心运行。 |
| E_GAMESTREAMING_NOT_STREAMING_CONTROLLER | 0x89245404 | 当前读取不是来自流式处理控制器。 |