> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# XGameStreamingGetStreamAddedLatency

> XGameStreamingGetStreamAddedLatency

# XGameStreamingGetStreamAddedLatency

获取与流式处理相关的延迟的近期平均值。

## 语法

```cpp theme={null}
HRESULT XGameStreamingGetStreamAddedLatency(  
         XGameStreamingClientId client,  
         uint32_t* averageInputLatencyUs,  
         uint32_t* averageOutputLatencyUs,  
         uint32_t* standardDeviationUs  
)  
```

### 参数

*client*   \_In\_\
类型：XGameStreamingClientId

正在查询延迟的流式处理客户端设备。

*averageInputLatencyUs*   \_Out\_\
类型：uint32\_t\*

XBOX 游戏接收输入的最近一段时间内的平均延迟（以微秒为单位）。

*averageOutputLatencyUs*   \_Out\_\
类型：uint32\_t\*

在客户端设备上呈现游戏帧的最近一段时间内的平均延迟（以微秒为单位）。

*standardDeviationUs*   \_Out\_\
类型：uint32\_t\*

在最近一段时间内的延迟中观察到的抖动测量标准差的平均值（以微秒为单位）。

### 返回值

类型：HRESULT

如果成功，则返回 **S\_OK**；否则返回错误代码。

#### 潜在错误

| 错误代码                               | 错误值        | 错误原因                                                                                                                                       |
| ---------------------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| E\_GAMESTREAMING\_NOT\_INITIALIZED | 0x89245400 | XGameStreaming 运行时尚未初始化。在调用其他 API 之前，请先调用 [XGameStreamingInitialize](/reference/system/xgamestreaming/functions/xgamestreaminginitialize)。 |
| E\_GAMESTREAMING\_NO\_DATA         | 0x89245402 | 请求的数据不可用。数据可能稍后可用。                                                                                                                         |

有关错误代码列表，请参阅[错误代码](/reference/errorcodes)。

## 备注

<Note>在时间敏感线程上调用此函数并不安全。有关详细信息，请参阅[时间敏感线程](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/console-dev/overviews/threads/time-sensitive-threads)。</Note>

<Note>如下所述，输入和输出延迟值衡量不同的值，可能从不同的来源计算得出。这些值预计不会相似，应独立处理。</Note>

`XGameStreamingGetStreamAddedLatency` 提供由于游戏流式处理而测得的延迟数据。游戏可以使用此数据更好地了解玩家在流式播放体验中的体验。

请务必注意，这**不**提供玩家可能注意到的完整端到端延迟（例如，它**不**直接映射到从连接到流式处理客户端设备的控制器上按下按钮到呈现考虑该按下的新帧。）例如，以下组件**不**包含在这些测量中：

* 游戏引擎渲染时间
* 从传递给客户端设备渲染到玩家看到图像的时间
* 客户端设备上控制器的蓝牙®传输和解码时间

相反，输入延迟包括：

* 游戏流式处理应用程序处理从控制器接收的输入所需的时间。
* 从游戏流式处理应用程序通过网络传输到运行游戏的服务器的时间。

输出延迟包括：

* 游戏渲染的每一帧的编码时间。
* 通过网络将该帧传输到玩家正在交互的应用程序的时间。
* 应用程序中的解码时间，因为它准备向玩家呈现该帧。

`XGameStreamingGetStreamAddedLatency` 是每隔几秒更新一次的平均测量值。若要进行更精确的测量，可以使用 [XGameStreamingGetAssociatedFrame](/reference/system/xgamestreaming/functions/xgamestreaminggetassociatedframe) API。有关详细信息，请参阅[游戏流式处理延迟补偿深入探究](/build/core-features/common/game-streaming/game-streaming-latency-compensation-deep-dive)。

## 要求

**标头：** xgamestreaming.h

**库：** xgameruntime.lib

**支持的平台：** Windows、XBOX One 系列主机和 XBOX Series 主机

## 概念性文档

* [游戏流式处理延迟补偿深入探究](/build/core-features/common/game-streaming/game-streaming-latency-compensation-deep-dive)
* [时间敏感线程](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/console-dev/overviews/threads/time-sensitive-threads)

## 另请参阅

[XGameStreaming](/reference/system/xgamestreaming/xgamestreaming_members)\
[游戏流式处理延迟补偿概述](/build/core-features/common/game-streaming/game-streaming-latency-compensation-overview)


## Related topics

- [游戏串流延迟补偿深入探讨](/zh-CN/build/core-features/common/game-streaming/game-streaming-latency-compensation-deep-dive.md)
- [XGameStreaming](/zh-CN/reference/system/xgamestreaming/xgamestreaming_members.md)
- [XGameStreamingGetAssociatedFrame](/zh-CN/reference/system/xgamestreaming/functions/xgamestreaminggetassociatedframe.md)
- [XGameStreamingGetLastFrameDisplayed](/zh-CN/reference/system/xgamestreaming/functions/xgamestreaminggetlastframedisplayed.md)
- [游戏串流延迟测量](/zh-CN/build/core-features/common/game-streaming/game-streaming-latency-measurement.md)