XGameStreaming
初始化
初始化遊戲串流功能所需的 API。| 函式 | 描述 |
|---|---|
| XGameStreamingInitialize | 初始化遊戲串流 API。 |
| XGameStreamingUninitialize | 取消初始化遊戲串流 API。 |
用戶端屬性
用於取得串流裝置或其遊戲串流屬性的 API函式
| 函式 | 描述 |
|---|---|
| XGameStreamingClientPropertiesChangedCallback | 串流裝置的屬性變更時的通知。 |
| XGameStreamingGetClientIPAddress | 已淘汰。 取得串流用戶端的 IP 位址。請改用 XSTS 權杖宣告。 |
| XGameStreamingGetDisplayDetails | 取得串流用戶端的顯示器詳細資料。 |
| XGameStreamingGetSessionId | 取得串流用戶端的工作階段識別碼。 |
| 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 執行階段尚未初始化。請先呼叫 XGameStreamingInitialize，再呼叫其他 API。 |
| E_GAMESTREAMING_CLIENT_NOT_CONNECTED | 0x89245401 | 指定的用戶端未連線。 |
| E_GAMESTREAMING_NO_DATA | 0x89245402 | 要求的資料無法使用。資料可能稍後才可使用。 |
| E_GAMESTREAMING_NO_DATACENTER | 0x89245403 | 目前的電腦不是在資料中心內執行。 |
| E_GAMESTREAMING_NOT_STREAMING_CONTROLLER | 0x89245404 | 目前的讀數並非來自串流控制器。 |