> ## 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.

# XGameStreaming

> XGameStreaming

# XGameStreaming

## 初始化

初始化遊戲串流功能所需的 API。

| 函式 | 描述 |
| :- | :- |
| [XGameStreamingInitialize](/zh-TW/reference/system/xgamestreaming/functions/xgamestreaminginitialize) | 初始化遊戲串流 API。 |
| [XGameStreamingUninitialize](/zh-TW/reference/system/xgamestreaming/functions/xgamestreaminguninitialize) | 取消初始化遊戲串流 API。 |

<a id="ClientProperties" />

## 用戶端屬性

用於取得串流裝置或其遊戲串流屬性的 API

### 函式

| 函式 | 描述 |
| :- | :- |
| [XGameStreamingClientPropertiesChangedCallback](/zh-TW/reference/system/xgamestreaming/functions/xgamestreamingclientpropertieschangedcallback) | 串流裝置的屬性變更時的通知。 |
| [XGameStreamingGetClientIPAddress](/zh-TW/reference/system/xgamestreaming/functions/xgamestreaminggetclientipaddress) | **已淘汰。** 取得串流用戶端的 IP 位址。請改用 XSTS 權杖宣告。 |
| [XGameStreamingGetDisplayDetails](/zh-TW/reference/system/xgamestreaming/functions/xgamestreaminggetdisplaydetails) | 取得串流用戶端的顯示器詳細資料。 |
| [XGameStreamingGetSessionId](/zh-TW/reference/system/xgamestreaming/functions/xgamestreaminggetsessionid) | 取得串流用戶端的工作階段識別碼。 |
| [XGameStreamingGetStreamPhysicalDimensions](/zh-TW/reference/system/xgamestreaming/functions/xgamestreaminggetstreamphysicaldimensions) | 取得目前在串流用戶端上呈現之視訊串流的實體大小。 |
| [XGameStreamingGetTouchBundleVersion](/zh-TW/reference/system/xgamestreaming/functions/xgamestreaminggettouchbundleversion) | 取得指定裝置上目前使用之觸控調整套件組合的版本。 |
| [XGameStreamingGetTouchBundleVersionNameSize](/zh-TW/reference/system/xgamestreaming/functions/xgamestreaminggettouchbundleversionnamesize) | 取得指定裝置上觸控調整套件組合中所指定版本名稱的大小。 |
| [XGameStreamingIsTouchInputEnabled](/zh-TW/reference/system/xgamestreaming/functions/xgamestreamingistouchinputenabled) | 檢查用戶端是否會將觸控輸入傳送至遊戲。 |
| [XGameStreamingRegisterClientPropertiesChanged](/zh-TW/reference/system/xgamestreaming/functions/xgamestreamingregisterclientpropertieschanged) | 註冊在串流用戶端裝置的任何屬性變更時要叫用的回呼。 |
| [XGameStreamingUnregisterClientPropertiesChanged](/zh-TW/reference/system/xgamestreaming/functions/xgamestreamingunregisterclientpropertieschanged) | 取消註冊先前註冊的 XGameStreamingClientPropertiesChangedCallback。 |

### 列舉

| 列舉 | 描述 |
| :- | :- |
| [XGameStreamingClientProperty](/zh-TW/reference/system/xgamestreaming/enums/xgamestreamingclientproperty) | 可查詢之用戶端串流裝置相關屬性。 |
| [XGameStreamingVideoFlags](/zh-TW/reference/system/xgamestreaming/enums/xgamestreamingvideoflags) | 用戶端串流裝置可能支援的可用視訊功能。 |

### 結構

| 結構 | 描述 |
| :- | :- |
| [XGameStreamingDisplayDetails](/zh-TW/reference/system/xgamestreaming/structs/xgamestreamingdisplaydetails) | 串流用戶端裝置之顯示器的詳細資料。 |

<a id="ConnectionState" />

## 連線狀態

管理串流用戶端裝置連線狀態所需的 API。

### 函式

| 函式 | 描述 |
| :- | :- |
| [XGameStreamingConnectionStateChangedCallback](/zh-TW/reference/system/xgamestreaming/functions/xgamestreamingconnectionstatechangedcallback) | 每當已連線之串流用戶端的狀態變更時要叫用的回呼函式。 |
| [XGameStreamingGetClientCount](/zh-TW/reference/system/xgamestreaming/functions/xgamestreaminggetclientcount) | 目前已連線的串流裝置數目。 |
| [XGameStreamingGetClients](/zh-TW/reference/system/xgamestreaming/functions/xgamestreaminggetclients) | 取得每個目前已連線用戶端的識別碼。 |
| [XGameStreamingGetConnectionState](/zh-TW/reference/system/xgamestreaming/functions/xgamestreaminggetconnectionstate) | 取得指定裝置目前的連線狀態。 |
| [XGameStreamingIsStreaming](/zh-TW/reference/system/xgamestreaming/functions/xgamestreamingisstreaming) | 判斷遊戲目前是否正在串流。 |
| [XGameStreamingRegisterConnectionStateChanged](/zh-TW/reference/system/xgamestreaming/functions/xgamestreamingregisterconnectionstatechanged) | 註冊在串流用戶端裝置的連線狀態變更時要叫用的回呼。 |
| [XGameStreamingUnregisterConnectionStateChanged](/zh-TW/reference/system/xgamestreaming/functions/xgamestreamingunregisterconnectionstatechanged) | 取消註冊先前註冊的 XGameStreamingConnectionStateChangedCallback。 |

### 列舉

| 列舉 | 描述 |
| :- | :- |
| [XGameStreamingConnectionState](/zh-TW/reference/system/xgamestreaming/enums/xgamestreamingconnectionstate) | 串流用戶端裝置的連線狀態。 |

<a id="Latency" />

## 延遲

針對串流延遲調整遊戲玩法的 API。

### 函式

| 函式 | 描述 |
| :- | :- |
| [XGameStreamingGetStreamAddedLatency](/zh-TW/reference/system/xgamestreaming/functions/xgamestreaminggetstreamaddedlatency) | 取得最近串流相關延遲的平均值。 |
| [XGameStreamingGetLastFrameDisplayed](/zh-TW/reference/system/xgamestreaming/functions/xgamestreaminggetlastframedisplayed) | **已淘汰。** 取得最近一次顯示在串流用戶端畫面上之畫面的畫面管線權杖。 |
| [XGameStreamingGetAssociatedFrame](/zh-TW/reference/system/xgamestreaming/functions/xgamestreaminggetassociatedframe) | **已淘汰。** 從特定輸入讀數取得畫面管線權杖。 |

## 伺服器位置

用於存取遊戲串流來源位置的 API。

### 函式

| 函式 | 描述 |
| :- | :- |
| [XGameStreamingGetServerLocationName](/zh-TW/reference/system/xgamestreaming/functions/xgamestreaminggetserverlocationname) | 取得串流伺服器的資料中心位置。 |
| [XGameStreamingGetServerLocationNameSize](/zh-TW/reference/system/xgamestreaming/functions/xgamestreaminggetserverlocationnamesize) | 取得串流伺服器資料中心位置名稱的大小 |

<a id="TouchAdaptation" />

## 觸控調整

管理將公開給適當串流用戶端之觸控控制器配置的 API。

### 函式

| 函式 | 描述 |
| :- | :- |
| [XGameStreamingGetGamepadPhysicality](/zh-TW/reference/system/xgamestreaming/functions/xgamestreaminggetgamepadphysicality) | 從特定遊戲台讀數取得輸入實體性對應。 |
| [XGameStreamingHideTouchControls](/zh-TW/reference/system/xgamestreaming/functions/xgamestreaminghidetouchcontrols) | 要求所有已連線的串流用戶端裝置在觸控配置可見時將其隱藏。 |
| [XGameStreamingHideTouchControlsOnClient](/zh-TW/reference/system/xgamestreaming/functions/xgamestreaminghidetouchcontrolsonclient) | 要求指定的串流用戶端裝置在觸控配置可見時將其隱藏。 |
| [XGameStreamingShowTouchControlLayout](/zh-TW/reference/system/xgamestreaming/functions/xgamestreamingshowtouchcontrollayout) | 要求所有已連線的串流用戶端裝置顯示指定的觸控配置。 |
| [XGameStreamingShowTouchControlLayoutOnClient](/zh-TW/reference/system/xgamestreaming/functions/xgamestreamingshowtouchcontrollayoutonclient) | 要求指定之已連線串流用戶端裝置顯示指定的觸控配置。 |
| [XGameStreamingShowTouchControlsWithStateUpdate](/zh-TW/reference/system/xgamestreaming/functions/xgamestreamingshowtouchcontrolswithstateupdate) | 要求所有已連線的串流用戶端裝置更新其觸控控制項狀態，然後顯示指定的觸控配置。 |
| [XGameStreamingShowTouchControlsWithStateUpdateOnClient](/zh-TW/reference/system/xgamestreaming/functions/xgamestreamingshowtouchcontrolswithstateupdateonclient) | 要求指定的串流用戶端裝置更新其觸控控制項狀態，然後顯示指定的觸控配置。 |
| [XGameStreamingUpdateTouchControlsState](/zh-TW/reference/system/xgamestreaming/functions/xgamestreamingupdatetouchcontrolsstate) | 更新所有已連線串流用戶端裝置上的觸控控制項狀態。 |
| [XGameStreamingUpdateTouchControlsStateOnClient](/zh-TW/reference/system/xgamestreaming/functions/xgamestreamingupdatetouchcontrolsstateonclient) | 更新指定串流用戶端裝置上的觸控控制項狀態。 |

### 列舉

| 列舉 | 描述 |
| :- | :- |
| [XGameStreamingGamepadPhysicality](/zh-TW/reference/system/xgamestreaming/enums/xgamestreaminggamepadphysicality) | 標準 XBOX 無線控制器上所有按鈕、搖桿和扳機的實體性對應。對於任何指定的按鈕/搖桿/扳機，實體性可以是未知、實體、虛擬或兩者皆是。 |
| [XGameStreamingTouchControlsStateOperationKind](/zh-TW/reference/system/xgamestreaming/enums/xgamestreamingtouchcontrolsstateoperationkind) | 更新觸控控制項配置狀態時可採取的作業。 |
| [XGameStreamingTouchControlsStateValueKind](/zh-TW/reference/system/xgamestreaming/enums/xgamestreamingtouchcontrolsstatevaluekind) | 指定與觸控配置相關聯之狀態的類型。 |

### 結構

| 結構 | 描述 |
| :- | :- |
| [XGameStreamingTouchControlsStateOperation](/zh-TW/reference/system/xgamestreaming/structs/xgamestreamingtouchcontrolsstateoperation) | 指定要套用的作業、特定變數的路徑和值。 |
| [XGameStreamingTouchControlsStateValue](/zh-TW/reference/system/xgamestreaming/structs/xgamestreamingtouchcontrolsstatevalue) | 提供觸控控制項狀態之特定元素的類型和值。 |

## 解析度

管理串流解析度的 API。

### 函式

| 函式 | 描述 |
| :- | :- |
| [XGameStreamingSetResolution](/zh-TW/reference/system/xgamestreaming/functions/xgamestreamingsetresolution) | 設定視訊串流的解析度。 |

## 錯誤碼

XGameStreaming API 可能會傳回下列錯誤碼。如需完整清單，請參閱[錯誤碼](/zh-TW/reference/errorcodes)。

| 代碼 | 值 | 描述 |
| - | - | - |
| E\_GAMESTREAMING\_NOT\_INITIALIZED | 0x89245400 | XGameStreaming 執行階段尚未初始化。請先呼叫 [XGameStreamingInitialize](/zh-TW/reference/system/xgamestreaming/functions/xgamestreaminginitialize)，再呼叫其他 API。 |
| E\_GAMESTREAMING\_CLIENT\_NOT\_CONNECTED | 0x89245401 | 指定的用戶端未連線。 |
| E\_GAMESTREAMING\_NO\_DATA | 0x89245402 | 要求的資料無法使用。資料可能稍後才可使用。 |
| E\_GAMESTREAMING\_NO\_DATACENTER | 0x89245403 | 目前的電腦不是在資料中心內執行。 |
| E\_GAMESTREAMING\_NOT\_STREAMING\_CONTROLLER | 0x89245404 | 目前的讀數並非來自串流控制器。 |

## 概念文件

* [雲端感知 API 呼叫](/zh-TW/build/core-features/common/game-streaming/game-streaming-am-i-streaming)
* [開始使用觸控](/zh-TW/build/core-features/common/game-streaming/game-streaming-getting-started-with-touch)
* [遊戲串流延遲補償深入探討](/zh-TW/build/core-features/common/game-streaming/game-streaming-latency-compensation-deep-dive)
* [遊戲串流延遲補償概觀](/zh-TW/build/core-features/common/game-streaming/game-streaming-latency-compensation-overview)
* [遊戲串流延遲測量](/zh-TW/build/core-features/common/game-streaming/game-streaming-latency-measurement)

## 另請參閱

[系統 API 參考](/zh-TW/reference/system/gc-reference-system-toc)


## Related topics

- [XGameStreaming](/reference/system/xgamestreaming/xgamestreaming_members.md)
- [XGameStreamingIsStreaming](/reference/system/xgamestreaming/functions/xgamestreamingisstreaming.md)
