XGameStreamingGetStreamAddedLatency
ストリーミングに関連するレイテンシの直近の平均を取得します。Syntax
Parameters
client _In_型: XGameStreamingClientId レイテンシを照会するストリーミング クライアント デバイス。 averageInputLatencyUs _Out_
型: uint32_t* XBOX のゲームが入力を受信するまでの、直近の期間における平均レイテンシ (マイクロ秒単位)。 averageOutputLatencyUs _Out_
型: uint32_t* ゲーム フレームがクライアント デバイスにレンダリングされるまでの、直近の期間における平均レイテンシ (マイクロ秒単位)。 standardDeviationUs _Out_
型: uint32_t* 直近の期間におけるレイテンシのジッターの測定された標準偏差の観測平均 (マイクロ秒単位)。
Return value
型: HRESULT 成功した場合は S_OK を返します。それ以外の場合はエラー コードを返します。想定されるエラー
エラー コードの一覧については、Error Codes を参照してください。
Remarks
この関数は、時間制約のあるスレッドで呼び出すには安全ではありません。詳細については、時間制約のあるスレッドを参照してください。
以下で説明するように、入力と出力のレイテンシ値は異なる値を測定しており、異なるソースから計算される場合があります。これらの値は類似することを想定しておらず、独立して扱う必要があります。
XGameStreamingGetStreamAddedLatency は、ゲームのストリーミングに起因する測定されたレイテンシに関するデータを提供します。ゲームはこれを利用して、プレイヤーがストリーミング エクスペリエンスで受けている体験をより正確に把握できます。
これは、プレイヤーが体感する可能性のあるエンドツーエンドのレイテンシを 提供しない 点に注意してください (例: ストリーミング クライアント デバイスに接続されたコントローラーのボタン押下から、それを反映した新しいフレームがレンダリングされるまでの経路に直接対応するわけではありません)。たとえば、次のコンポーネントはこれらの測定に 含まれません。
- ゲーム エンジンのレンダリング時間
- クライアント デバイスでレンダリングに渡されてから、プレイヤーが映像を目にするまでの時間
- クライアント デバイス上のコントローラーからの Bluetooth® の転送およびデコード時間
- ゲーム ストリーミング アプリケーションがコントローラーから受信した入力を処理する時間。
- ゲーム ストリーミング アプリケーションからネットワーク経由でゲームを実行しているサーバーへの伝送時間。
- タイトルによってレンダリングされる各フレームのエンコード時間。
- このフレームをネットワーク経由でプレイヤーが操作しているアプリケーションへ伝送する時間。
- フレームをプレイヤーに提示する準備を行うためのアプリケーション内でのデコード時間。
XGameStreamingGetStreamAddedLatency は、数秒ごとに更新される平均測定値です。より精密な測定には XGameStreamingGetAssociatedFrame API を使用できます。詳細については Game streaming latency compensation deep dive を参照してください。
Requirements
ヘッダー: xgamestreaming.h ライブラリ: xgameruntime.lib サポートされているプラットフォーム: Windows、XBOX One ファミリー本体および XBOX Series 本体Conceptual documentation
See also
XGameStreamingGame Streaming Latency Compensation Overview