次の方法で共有

XGameStreamingGetStreamAddedLatency

  • [アーティクル]

ストリーミングに関連する待機時間の最近の平均値を取得します。

構文

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 を呼び出してください。
E_GAMESTREAMING_NO_DATA 0x89245402 要求されたデータは利用できません。 データは後で利用可能になる場合があります。

エラー コードの一覧については、「エラー コード」をご覧ください。

解説

注意

この関数は、時間依存のスレッドで呼び出すのに安全ではありません。 詳細については、「時間依存のスレッド」を参照してください。

注意

次に説明するように、入力と出力の待機時間の値は異なる値を測定し、さまざまなソースから計算できます。 これらの値は似ているとは思われず、個別に扱う必要があります。

XGameStreamingGetStreamAddedLatency は、ゲームのストリーミングによって測定された遅延に関するデータを提供します。 これをゲームで利用すると、プレイヤーがストリーミングで体験しているエクスペリエンスをより深く理解できます。

これは、プレイヤーが気付く可能性がある完全なエンドツーエンドの待ち時間を提供 しない ことに注意することが重要です (たとえば、それを考慮に入れた新しいフレームがレンダリングされるまでは、ストリーミング クライアント デバイスに接続されているコントローラーのボタン押下に直接マップ されません)。たとえば、次のコンポーネントは、これらの測定値含まれていません 。

  • ゲーム エンジンのレンダリング時間
  • クライアント デバイスに渡されてから、プレイヤーにイメージが表示されるまでの時間
  • クライアント デバイス上のコントローラーからの Bluetooth® のトランスポートおよびデコード時間

代わりに、入力遅延には次のものが含まれます。

  • ゲーム ストリーミング アプリケーションがコントローラーから受信した入力を処理するのにかかる時間。
  • ネットワークを介したゲーム ストリーミング アプリケーションからゲームを実行しているサーバーへの送信時間。

出力レイテンシには次のものが含まれます。

  • タイトルによってレンダリングされる各フレームのエンコード時間。
  • このフレームをネットワークを介して、プレーヤーが対話しているアプリケーションに送信する時間。
  • プレーヤーにフレームを提示する準備をするための、アプリケーションでのデコード時間。

XGameStreamingGetStreamAddedLatency は、数秒ごとに更新される平均測定値です。 より正確な測定のために、XGameStreamingGetAssociatedFrame API を使用できます。 詳細については、「ゲーム ストリーミング待機時間補正の詳細」を参照してください。

要件

ヘッダー: xgamestreaming.h

ライブラリ: xgameruntime.lib

サポートされているプラットフォーム: Windows、Xbox One ファミリー本体、Xbox Series 本体

関連項目

XGameStreaming
ゲーム ストリーミング待機時間補正の概要