> ## 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-CN/reference/system/xappcapture/functions/xappbroadcastgetstatus.md) | 检索设备和当前应用的当前广播状态。 |
| [XAppBroadcastIsAppBroadcasting](https://docs.xbox.com/zh-CN/reference/system/xappcapture/functions/xappbroadcastisappbroadcasting.md) | 确定应用当前是否正在广播。 |
| [XAppBroadcastMonitorCallback](https://docs.xbox.com/zh-CN/reference/system/xappcapture/functions/xappbroadcastmonitorcallback.md) | 设置 [XAppBroadcastRegisterIsAppBroadcastingChanged](https://docs.xbox.com/zh-CN/reference/system/xappcapture/functions/xappbroadcastregisterisappbroadcastingchanged.md) 的回调函数。每当广播状态更改时都会调用此处设置的函数。 |
| [XAppBroadcastRegisterIsAppBroadcastingChanged](https://docs.xbox.com/zh-CN/reference/system/xappcapture/functions/xappbroadcastregisterisappbroadcastingchanged.md) | 注册应用广播状态更改事件处理程序。 |
| [XAppBroadcastShowUI](https://docs.xbox.com/zh-CN/reference/system/xappcapture/functions/xappbroadcastshowui.md) | 向应用用户显示广播 UI，以便他们可以开始广播活动。 |
| [XAppBroadcastUnregisterIsAppBroadcastingChanged](https://docs.xbox.com/zh-CN/reference/system/xappcapture/functions/xappbroadcastunregisterisappbroadcastingchanged.md) | 移除应用广播状态更改事件处理程序。 |
| [XAppCaptureCancelUserRecord](https://docs.xbox.com/zh-CN/reference/system/xappcapture/functions/xappcapturecanceluserrecord.md) | 停止并删除通过 [XAppCaptureStartUserRecord](https://docs.xbox.com/zh-CN/reference/system/xappcapture/functions/xappcapturestartuserrecord.md) 启动、由输入的 ID 指定的正在进行的 GameDVR 用户录制。 |
| [XAppCaptureCloseLocalStream](https://docs.xbox.com/zh-CN/reference/system/xappcapture/functions/xappcapturecloselocalstream.md) | 关闭并删除指定的录制流。 |
| [XAppCaptureCloseScreenshotStream](https://docs.xbox.com/zh-CN/reference/system/xappcapture/functions/xappcaptureclosescreenshotstream.md) | 关闭屏幕截图流。 |
| [XAppCaptureDisableRecord](https://docs.xbox.com/zh-CN/reference/system/xappcapture/functions/xappcapturedisablerecord.md) | 为玩家禁用视频录制。 |
| [XAppCaptureEnableRecord](https://docs.xbox.com/zh-CN/reference/system/xappcapture/functions/xappcaptureenablerecord.md) | 为当前用户启用录制/屏幕截图。 |
| [XAppCaptureGetVideoCaptureSettings](https://docs.xbox.com/zh-CN/reference/system/xappcapture/functions/xappcapturegetvideocapturesettings.md) | 查询设备的 GameDVR 设置，包括编码类型、颜色格式、分辨率、最大可能录制长度以及当前用户是否允许游戏进行捕获。 |
| [XAppCaptureMetadataAddDoubleEvent](https://docs.xbox.com/zh-CN/reference/system/xappcapture/functions/xappcapturemetadataadddoubleevent.md) | 向应用捕获添加一个包含 double 值的元数据事件。 |
| [XAppCaptureMetadataAddInt32Event](https://docs.xbox.com/zh-CN/reference/system/xappcapture/functions/xappcapturemetadataaddint32event.md) | 向应用捕获添加一个包含 Int32 值的元数据事件。 |
| [XAppCaptureMetadataAddStringEvent](https://docs.xbox.com/zh-CN/reference/system/xappcapture/functions/xappcapturemetadataaddstringevent.md) | 向应用捕获添加一个包含字符串值的元数据事件。 |
| [XAppCaptureMetadataPurgedCallback](https://docs.xbox.com/zh-CN/reference/system/xappcapture/functions/xappcapturemetadatapurgedcallback.md) | 设置发生元数据清除时要调用的回调函数。 |
| [XAppCaptureMetadataRemainingStorageBytesAvailable](https://docs.xbox.com/zh-CN/reference/system/xappcapture/functions/xappcapturemetadataremainingstoragebytesavailable.md) | 返回可用于应用捕获元数据的剩余存储空间（以字节为单位）。 |
| [XAppCaptureMetadataStartDoubleState](https://docs.xbox.com/zh-CN/reference/system/xappcapture/functions/xappcapturemetadatastartdoublestate.md) | 向应用捕获添加一个包含 double 值的元数据状态。 |
| [XAppCaptureMetadataStartInt32State](https://docs.xbox.com/zh-CN/reference/system/xappcapture/functions/xappcapturemetadatastartint32state.md) | 向应用捕获添加一个包含 Int32 值的元数据状态。 |
| [XAppCaptureMetadataStartStringState](https://docs.xbox.com/zh-CN/reference/system/xappcapture/functions/xappcapturemetadatastartstringstate.md) | 向应用捕获添加一个包含字符串值的元数据状态。 |
| [XAppCaptureMetadataStopAllStates](https://docs.xbox.com/zh-CN/reference/system/xappcapture/functions/xappcapturemetadatastopallstates.md) | 停止当前处于活动状态的所有状态事件。 |
| [XAppCaptureMetadataStopState](https://docs.xbox.com/zh-CN/reference/system/xappcapture/functions/xappcapturemetadatastopstate.md) | 向应用捕获元数据添加针对特定命名状态的状态停止。 |
| [XAppCaptureOpenScreenshotStream](https://docs.xbox.com/zh-CN/reference/system/xappcapture/functions/xappcaptureopenscreenshotstream.md) | 打开屏幕截图流。 |
| [XAppCaptureReadLocalStream](https://docs.xbox.com/zh-CN/reference/system/xappcapture/functions/xappcapturereadlocalstream.md) | 读取先前调用 [XAppCaptureRecordTimespan](https://docs.xbox.com/zh-CN/reference/system/xappcapture/functions/xappcapturerecordtimespan.md) 生成的 .mp4 文件的内容。 |
| [XAppCaptureReadScreenshotStream](https://docs.xbox.com/zh-CN/reference/system/xappcapture/functions/xappcapturereadscreenshotstream.md) | 读取屏幕截图流。 |
| [XAppCaptureRecordDiagnosticClip](https://docs.xbox.com/zh-CN/reference/system/xappcapture/functions/xappcapturerecorddiagnosticclip.md) | 从应用中录制诊断剪辑。 |
| [XAppCaptureRecordTimespan](https://docs.xbox.com/zh-CN/reference/system/xappcapture/functions/xappcapturerecordtimespan.md) | 进行 GameDVR 录制。 |
| [XAppCaptureRegisterMetadataPurged](https://docs.xbox.com/zh-CN/reference/system/xappcapture/functions/xappcaptureregistermetadatapurged.md) | 为元数据清除事件注册事件处理程序。 |
| [XAppCaptureStartUserRecord](https://docs.xbox.com/zh-CN/reference/system/xappcapture/functions/xappcapturestartuserrecord.md) | 如同用户触发的一样开始录制。 |
| [XAppCaptureStopUserRecord](https://docs.xbox.com/zh-CN/reference/system/xappcapture/functions/xappcapturestopuserrecord.md) | 停止并保存通过 [XAppCaptureStartUserRecord](https://docs.xbox.com/zh-CN/reference/system/xappcapture/functions/xappcapturestartuserrecord.md) 启动、由输入的 ID 指定的正在进行的用户录制。 |
| [XAppCaptureTakeDiagnosticScreenshot](https://docs.xbox.com/zh-CN/reference/system/xappcapture/functions/xappcapturetakediagnosticscreenshot.md) | 从应用截取诊断屏幕截图。 |
| [XAppCaptureTakeScreenshot](https://docs.xbox.com/zh-CN/reference/system/xappcapture/functions/xappcapturetakescreenshot.md) | 截取屏幕截图。 |
| [XAppCaptureUnRegisterMetadataPurged](https://docs.xbox.com/zh-CN/reference/system/xappcapture/functions/xappcaptureunregistermetadatapurged.md) | 移除元数据清除事件的事件处理程序。 |

## 结构体

| 结构体 | 说明 |
| - | - |
| [XAppBroadcastStatus](https://docs.xbox.com/zh-CN/reference/system/xappcapture/structs/xappbroadcaststatus.md) | 描述应用/游戏广播能力的状态。 |
| [XAppCaptureDiagnosticScreenshotResult](https://docs.xbox.com/zh-CN/reference/system/xappcapture/structs/xappcapturediagnosticscreenshotresult.md) | 应用捕获屏幕截图及描述性信息。 |
| [XAppCaptureLocalResult](https://docs.xbox.com/zh-CN/reference/system/xappcapture/structs/xappcapturelocalresult.md) | 包含调用 XAppCaptureRecordTimespan 的结果。 |
| [XAppCaptureRecordClipResult](https://docs.xbox.com/zh-CN/reference/system/xappcapture/structs/xappcapturerecordclipresult.md) | 捕获的视频剪辑及描述性信息。 |
| [XAppCaptureScreenshotFile](https://docs.xbox.com/zh-CN/reference/system/xappcapture/structs/xappcapturescreenshotfile.md) | 捕获的屏幕截图及描述性信息。 |
| [XAppCaptureScreenshotStream](https://docs.xbox.com/zh-CN/reference/system/xappcapture/structs/xappcapturescreenshotstream.md) | 表示屏幕截图流。 |
| [XAppCaptureTakeScreenshotResult](https://docs.xbox.com/zh-CN/reference/system/xappcapture/structs/xappcapturetakescreenshotresult.md) | 表示截取屏幕截图的结果。 |
| [XAppCaptureUserRecordingResult](https://docs.xbox.com/zh-CN/reference/system/xappcapture/structs/xappcaptureuserrecordingresult.md) | 包含调用 [XAppCaptureStopUserRecord](https://docs.xbox.com/zh-CN/reference/system/xappcapture/functions/xappcapturestopuserrecord.md) 的结果。 |
| [XAppCaptureVideoCaptureSettings](https://docs.xbox.com/zh-CN/reference/system/xappcapture/structs/xappcapturevideocapturesettings.md) | GameDVR 视频捕获设置。 |

## 枚举

| 枚举 | 说明 |
| - | - |
| [XAppCaptureMetadataPriority](https://docs.xbox.com/zh-CN/reference/system/xappcapture/enums/xappcapturemetadatapriority.md) | 应用捕获元数据的优先级级别。用于在实施存储约束且必须删除某些元数据时确定哪些数据最重要。 |
| [XAppCaptureScreenshotFormatFlag](https://docs.xbox.com/zh-CN/reference/system/xappcapture/enums/xappcapturescreenshotformatflag.md) | 确定屏幕截图捕获的清晰度质量。 |
| [XAppCaptureVideoColorFormat](https://docs.xbox.com/zh-CN/reference/system/xappcapture/enums/xappcapturevideocolorformat.md) | 在 GameDVR 录制中使用的颜色格式。 |
| [XAppCaptureVideoEncoding](https://docs.xbox.com/zh-CN/reference/system/xappcapture/enums/xappcapturevideoencoding.md) | 确定视频捕获的视频编码类型。 |

## Conceptual documentation

* [Game DVR 和广播](https://docs.xbox.com/zh-CN/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 游戏开发工具包？](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/intro/introduction)
* [在 Unity 项目中使用 GDK API 的 C# 包装器](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/pc-dev/tutorials/get-started-with-unity-pc/features/gdk-unity-api-wrappers)

## See also

[XAppCapture Error Codes](https://docs.xbox.com/zh-CN/reference/system/xappcapture/xappcapture_errors.md)\
[系统 API 参考](https://docs.xbox.com/zh-CN/reference/system/gc-reference-system-toc.md)


## Related topics

- [XAppCapture Error Codes](https://docs.xbox.com/zh-CN/reference/system/xappcapture/xappcapture_errors.md)
- [XAppCaptureScreenshotStream](https://docs.xbox.com/zh-CN/reference/system/xappcapture/structs/xappcapturescreenshotstream.md)
- [XAppCaptureReadLocalStream](https://docs.xbox.com/zh-CN/reference/system/xappcapture/functions/xappcapturereadlocalstream.md)
- [XAppCaptureVideoEncoding](https://docs.xbox.com/zh-CN/reference/system/xappcapture/enums/xappcapturevideoencoding.md)
- [XAppCaptureCancelUserRecord](https://docs.xbox.com/zh-CN/reference/system/xappcapture/functions/xappcapturecanceluserrecord.md)