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

# XAppCapture (API 內容)

> XAppCapture

# XAppCapture

XBOX 和桌面平台都包含原生廣播體驗，各自有關於使用者可以廣播哪些應用程式的規則。這些 API 可讓開發人員開啟廣播 UI，並偵測使用者何時正在廣播。應用程式開發人員可以提供中繼資料事件和狀態，以便與擷取的影片和音訊檔案/資料流一起儲存或廣播。

## 函式

| 函式 | 描述 |
| - | - |
| [XAppBroadcastGetStatus](https://docs.xbox.com/zh-TW/reference/system/xappcapture/functions/xappbroadcastgetstatus.md) | 擷取裝置和目前應用程式的目前廣播狀態。 |
| [XAppBroadcastIsAppBroadcasting](https://docs.xbox.com/zh-TW/reference/system/xappcapture/functions/xappbroadcastisappbroadcasting.md) | 判斷應用程式目前是否正在廣播。 |
| [XAppBroadcastMonitorCallback](https://docs.xbox.com/zh-TW/reference/system/xappcapture/functions/xappbroadcastmonitorcallback.md) | 設定 [XAppBroadcastRegisterIsAppBroadcastingChanged](https://docs.xbox.com/zh-TW/reference/system/xappcapture/functions/xappbroadcastregisterisappbroadcastingchanged.md) 的回呼函式。每次廣播狀態變更時，都會呼叫此處設定的函式。 |
| [XAppBroadcastRegisterIsAppBroadcastingChanged](https://docs.xbox.com/zh-TW/reference/system/xappcapture/functions/xappbroadcastregisterisappbroadcastingchanged.md) | 註冊應用程式廣播狀態變更事件處理常式。 |
| [XAppBroadcastShowUI](https://docs.xbox.com/zh-TW/reference/system/xappcapture/functions/xappbroadcastshowui.md) | 向應用程式使用者顯示廣播 UI，讓他們可以開始廣播活動。 |
| [XAppBroadcastUnregisterIsAppBroadcastingChanged](https://docs.xbox.com/zh-TW/reference/system/xappcapture/functions/xappbroadcastunregisterisappbroadcastingchanged.md) | 移除應用程式廣播狀態變更事件處理常式。 |
| [XAppCaptureCancelUserRecord](https://docs.xbox.com/zh-TW/reference/system/xappcapture/functions/xappcapturecanceluserrecord.md) | 停止並刪除透過 [XAppCaptureStartUserRecord](https://docs.xbox.com/zh-TW/reference/system/xappcapture/functions/xappcapturestartuserrecord.md) 開始並由輸入的識別碼指定的進行中 GameDVR 使用者錄製。 |
| [XAppCaptureCloseLocalStream](https://docs.xbox.com/zh-TW/reference/system/xappcapture/functions/xappcapturecloselocalstream.md) | 關閉並刪除指定的錄製資料流。 |
| [XAppCaptureCloseScreenshotStream](https://docs.xbox.com/zh-TW/reference/system/xappcapture/functions/xappcaptureclosescreenshotstream.md) | 關閉螢幕擷取畫面資料流。 |
| [XAppCaptureDisableRecord](https://docs.xbox.com/zh-TW/reference/system/xappcapture/functions/xappcapturedisablerecord.md) | 停用玩家的影片錄製。 |
| [XAppCaptureEnableRecord](https://docs.xbox.com/zh-TW/reference/system/xappcapture/functions/xappcaptureenablerecord.md) | 為目前使用者啟用錄製/螢幕擷取畫面。 |
| [XAppCaptureGetVideoCaptureSettings](https://docs.xbox.com/zh-TW/reference/system/xappcapture/functions/xappcapturegetvideocapturesettings.md) | 查詢裝置的 GameDVR 設定，包括編碼類型、色彩格式、解析度、可能的最大錄製長度，以及目前使用者是否允許遊戲進行擷取。 |
| [XAppCaptureMetadataAddDoubleEvent](https://docs.xbox.com/zh-TW/reference/system/xappcapture/functions/xappcapturemetadataadddoubleevent.md) | 將具有 double 值的中繼資料事件新增至您的應用程式擷取。 |
| [XAppCaptureMetadataAddInt32Event](https://docs.xbox.com/zh-TW/reference/system/xappcapture/functions/xappcapturemetadataaddint32event.md) | 將具有 Int32 值的中繼資料事件新增至您的應用程式擷取。 |
| [XAppCaptureMetadataAddStringEvent](https://docs.xbox.com/zh-TW/reference/system/xappcapture/functions/xappcapturemetadataaddstringevent.md) | 將具有字串值的中繼資料事件新增至您的應用程式擷取。 |
| [XAppCaptureMetadataPurgedCallback](https://docs.xbox.com/zh-TW/reference/system/xappcapture/functions/xappcapturemetadatapurgedcallback.md) | 設定發生中繼資料清除時要呼叫的回呼函式。 |
| [XAppCaptureMetadataRemainingStorageBytesAvailable](https://docs.xbox.com/zh-TW/reference/system/xappcapture/functions/xappcapturemetadataremainingstoragebytesavailable.md) | 傳回應用程式擷取中繼資料的剩餘可用儲存空間。以位元組為單位。 |
| [XAppCaptureMetadataStartDoubleState](https://docs.xbox.com/zh-TW/reference/system/xappcapture/functions/xappcapturemetadatastartdoublestate.md) | 將具有 double 值的中繼資料狀態新增至您的應用程式擷取。 |
| [XAppCaptureMetadataStartInt32State](https://docs.xbox.com/zh-TW/reference/system/xappcapture/functions/xappcapturemetadatastartint32state.md) | 將具有 Int32 值的中繼資料狀態新增至您的應用程式擷取。 |
| [XAppCaptureMetadataStartStringState](https://docs.xbox.com/zh-TW/reference/system/xappcapture/functions/xappcapturemetadatastartstringstate.md) | 將具有字串值的中繼資料狀態新增至您的應用程式擷取。 |
| [XAppCaptureMetadataStopAllStates](https://docs.xbox.com/zh-TW/reference/system/xappcapture/functions/xappcapturemetadatastopallstates.md) | 停止目前作用中的所有狀態事件。 |
| [XAppCaptureMetadataStopState](https://docs.xbox.com/zh-TW/reference/system/xappcapture/functions/xappcapturemetadatastopstate.md) | 將特定具名狀態的狀態停止新增至應用程式擷取中繼資料。 |
| [XAppCaptureOpenScreenshotStream](https://docs.xbox.com/zh-TW/reference/system/xappcapture/functions/xappcaptureopenscreenshotstream.md) | 開啟螢幕擷取畫面資料流。 |
| [XAppCaptureReadLocalStream](https://docs.xbox.com/zh-TW/reference/system/xappcapture/functions/xappcapturereadlocalstream.md) | 讀取先前呼叫 [XAppCaptureRecordTimespan](https://docs.xbox.com/zh-TW/reference/system/xappcapture/functions/xappcapturerecordtimespan.md) 所產生之 .mp4 檔案的內容。 |
| [XAppCaptureReadScreenshotStream](https://docs.xbox.com/zh-TW/reference/system/xappcapture/functions/xappcapturereadscreenshotstream.md) | 讀取螢幕擷取畫面資料流。 |
| [XAppCaptureRecordDiagnosticClip](https://docs.xbox.com/zh-TW/reference/system/xappcapture/functions/xappcapturerecorddiagnosticclip.md) | 從您的應用程式錄製診斷剪輯。 |
| [XAppCaptureRecordTimespan](https://docs.xbox.com/zh-TW/reference/system/xappcapture/functions/xappcapturerecordtimespan.md) | 進行 GameDVR 錄製。 |
| [XAppCaptureRegisterMetadataPurged](https://docs.xbox.com/zh-TW/reference/system/xappcapture/functions/xappcaptureregistermetadatapurged.md) | 註冊中繼資料清除事件的事件處理常式。 |
| [XAppCaptureStartUserRecord](https://docs.xbox.com/zh-TW/reference/system/xappcapture/functions/xappcapturestartuserrecord.md) | 以如同使用者觸發的方式開始錄製。 |
| [XAppCaptureStopUserRecord](https://docs.xbox.com/zh-TW/reference/system/xappcapture/functions/xappcapturestopuserrecord.md) | 停止並儲存透過 [XAppCaptureStartUserRecord](https://docs.xbox.com/zh-TW/reference/system/xappcapture/functions/xappcapturestartuserrecord.md) 開始並由輸入的識別碼指定的進行中使用者錄製。 |
| [XAppCaptureTakeDiagnosticScreenshot](https://docs.xbox.com/zh-TW/reference/system/xappcapture/functions/xappcapturetakediagnosticscreenshot.md) | 從您的應用程式擷取診斷螢幕擷取畫面。 |
| [XAppCaptureTakeScreenshot](https://docs.xbox.com/zh-TW/reference/system/xappcapture/functions/xappcapturetakescreenshot.md) | 擷取螢幕擷取畫面。 |
| [XAppCaptureUnRegisterMetadataPurged](https://docs.xbox.com/zh-TW/reference/system/xappcapture/functions/xappcaptureunregistermetadatapurged.md) | 移除中繼資料清除事件的事件處理常式。 |

## 結構

| 結構 | 描述 |
| - | - |
| [XAppBroadcastStatus](https://docs.xbox.com/zh-TW/reference/system/xappcapture/structs/xappbroadcaststatus.md) | 描述應用程式/遊戲的廣播功能狀態。 |
| [XAppCaptureDiagnosticScreenshotResult](https://docs.xbox.com/zh-TW/reference/system/xappcapture/structs/xappcapturediagnosticscreenshotresult.md) | 應用程式擷取的螢幕擷取畫面和描述性資訊。 |
| [XAppCaptureLocalResult](https://docs.xbox.com/zh-TW/reference/system/xappcapture/structs/xappcapturelocalresult.md) | 包含呼叫 XAppCaptureRecordTimespan 的結果。 |
| [XAppCaptureRecordClipResult](https://docs.xbox.com/zh-TW/reference/system/xappcapture/structs/xappcapturerecordclipresult.md) | 擷取的影片剪輯和描述性資訊。 |
| [XAppCaptureScreenshotFile](https://docs.xbox.com/zh-TW/reference/system/xappcapture/structs/xappcapturescreenshotfile.md) | 擷取的螢幕擷取畫面和描述性資訊。 |
| [XAppCaptureScreenshotStream](https://docs.xbox.com/zh-TW/reference/system/xappcapture/structs/xappcapturescreenshotstream.md) | 代表螢幕擷取畫面資料流。 |
| [XAppCaptureTakeScreenshotResult](https://docs.xbox.com/zh-TW/reference/system/xappcapture/structs/xappcapturetakescreenshotresult.md) | 代表擷取螢幕擷取畫面的結果。 |
| [XAppCaptureUserRecordingResult](https://docs.xbox.com/zh-TW/reference/system/xappcapture/structs/xappcaptureuserrecordingresult.md) | 包含呼叫 [XAppCaptureStopUserRecord](https://docs.xbox.com/zh-TW/reference/system/xappcapture/functions/xappcapturestopuserrecord.md) 的結果。 |
| [XAppCaptureVideoCaptureSettings](https://docs.xbox.com/zh-TW/reference/system/xappcapture/structs/xappcapturevideocapturesettings.md) | GameDVR 影片擷取設定。 |

## 列舉

| 列舉 | 描述 |
| - | - |
| [XAppCaptureMetadataPriority](https://docs.xbox.com/zh-TW/reference/system/xappcapture/enums/xappcapturemetadatapriority.md) | 應用程式擷取中繼資料的優先順序層級。用於在實施儲存空間限制且必須刪除某些中繼資料時，判斷哪些資料最重要。 |
| [XAppCaptureScreenshotFormatFlag](https://docs.xbox.com/zh-TW/reference/system/xappcapture/enums/xappcapturescreenshotformatflag.md) | 決定螢幕擷取畫面的畫質。 |
| [XAppCaptureVideoColorFormat](https://docs.xbox.com/zh-TW/reference/system/xappcapture/enums/xappcapturevideocolorformat.md) | GameDVR 錄製中使用的色彩格式。 |
| [XAppCaptureVideoEncoding](https://docs.xbox.com/zh-TW/reference/system/xappcapture/enums/xappcapturevideoencoding.md) | 決定影片擷取的影片編碼類型。 |

## 概念文件

* [Game DVR 和廣播](https://docs.xbox.com/zh-TW/build/console-features/game-dvr/gamedvr-broadcast.md)
* [時間敏感執行緒](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/console-dev/overviews/threads/time-sensitive-threads)
* [什麼是 Microsoft Game Development Kit？](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/intro/introduction)
* [在 Unity 專案中使用 GDK API 的 C# 包裝函式](https://docs.xbox.com/zh-TW/build/gdk-and-engines/unity/unity-api-wrappers.md)

## 另請參閱

[XAppCapture 錯誤碼](https://docs.xbox.com/zh-TW/reference/system/xappcapture/xappcapture_errors.md)\
[系統 API 參考](https://docs.xbox.com/zh-TW/reference/system/gc-reference-system-toc.md)


## Related topics

- [XAppCapture 錯誤碼](https://docs.xbox.com/zh-TW/reference/system/xappcapture/xappcapture_errors.md)
- [XAppCaptureVideoCaptureSettings](https://docs.xbox.com/zh-TW/reference/system/xappcapture/structs/xappcapturevideocapturesettings.md)
- [XAppCaptureLocalResult](https://docs.xbox.com/zh-TW/reference/system/xappcapture/structs/xappcapturelocalresult.md)
- [XAppCaptureUserRecordingResult](https://docs.xbox.com/zh-TW/reference/system/xappcapture/structs/xappcaptureuserrecordingresult.md)
- [XAppCaptureRecordTimespan](https://docs.xbox.com/zh-TW/reference/system/xappcapture/functions/xappcapturerecordtimespan.md)