> ## 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. # XAppCapture > XAppCapture # XAppCapture XBOX 和桌面平台都包含原生广播体验，每个平台对于用户可以广播哪些应用程序都有自己的规则。这些 API 允许开发人员调出广播 UI 以及检测用户何时在广播。应用开发人员可以提供元数据事件和状态，与捕获的视频和音频文件/流一起保存或广播。 ## 函数 | 函数 | 说明 | | ---------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [XAppBroadcastGetStatus](/reference/system/xappcapture/functions/xappbroadcastgetstatus) | 检索设备和当前应用的当前广播状态。 | | [XAppBroadcastIsAppBroadcasting](/reference/system/xappcapture/functions/xappbroadcastisappbroadcasting) | 确定应用当前是否正在广播。 | | [XAppBroadcastMonitorCallback](/reference/system/xappcapture/functions/xappbroadcastmonitorcallback) | 设置 [XAppBroadcastRegisterIsAppBroadcastingChanged](/reference/system/xappcapture/functions/xappbroadcastregisterisappbroadcastingchanged) 的回调函数。每当广播状态更改时都会调用此处设置的函数。 | | [XAppBroadcastRegisterIsAppBroadcastingChanged](/reference/system/xappcapture/functions/xappbroadcastregisterisappbroadcastingchanged) | 注册应用广播状态更改事件处理程序。 | | [XAppBroadcastShowUI](/reference/system/xappcapture/functions/xappbroadcastshowui) | 向应用用户显示广播 UI，以便他们可以开始广播活动。 | | [XAppBroadcastUnregisterIsAppBroadcastingChanged](/reference/system/xappcapture/functions/xappbroadcastunregisterisappbroadcastingchanged) | 移除应用广播状态更改事件处理程序。 | | [XAppCaptureCancelUserRecord](/reference/system/xappcapture/functions/xappcapturecanceluserrecord) | 停止并删除通过 [XAppCaptureStartUserRecord](/reference/system/xappcapture/functions/xappcapturestartuserrecord) 启动、由输入的 ID 指定的正在进行的 GameDVR 用户录制。 | | [XAppCaptureCloseLocalStream](/reference/system/xappcapture/functions/xappcapturecloselocalstream) | 关闭并删除指定的录制流。 | | [XAppCaptureCloseScreenshotStream](/reference/system/xappcapture/functions/xappcaptureclosescreenshotstream) | 关闭屏幕截图流。 | | [XAppCaptureDisableRecord](/reference/system/xappcapture/functions/xappcapturedisablerecord) | 为玩家禁用视频录制。 | | [XAppCaptureEnableRecord](/reference/system/xappcapture/functions/xappcaptureenablerecord) | 为当前用户启用录制/屏幕截图。 | | [XAppCaptureGetVideoCaptureSettings](/reference/system/xappcapture/functions/xappcapturegetvideocapturesettings) | 查询设备的 GameDVR 设置，包括编码类型、颜色格式、分辨率、最大可能录制长度以及当前用户是否允许游戏进行捕获。 | | [XAppCaptureMetadataAddDoubleEvent](/reference/system/xappcapture/functions/xappcapturemetadataadddoubleevent) | 向应用捕获添加一个包含 double 值的元数据事件。 | | [XAppCaptureMetadataAddInt32Event](/reference/system/xappcapture/functions/xappcapturemetadataaddint32event) | 向应用捕获添加一个包含 Int32 值的元数据事件。 | | [XAppCaptureMetadataAddStringEvent](/reference/system/xappcapture/functions/xappcapturemetadataaddstringevent) | 向应用捕获添加一个包含字符串值的元数据事件。 | | [XAppCaptureMetadataPurgedCallback](/reference/system/xappcapture/functions/xappcapturemetadatapurgedcallback) | 设置发生元数据清除时要调用的回调函数。 | | [XAppCaptureMetadataRemainingStorageBytesAvailable](/reference/system/xappcapture/functions/xappcapturemetadataremainingstoragebytesavailable) | 返回可用于应用捕获元数据的剩余存储空间（以字节为单位）。 | | [XAppCaptureMetadataStartDoubleState](/reference/system/xappcapture/functions/xappcapturemetadatastartdoublestate) | 向应用捕获添加一个包含 double 值的元数据状态。 | | [XAppCaptureMetadataStartInt32State](/reference/system/xappcapture/functions/xappcapturemetadatastartint32state) | 向应用捕获添加一个包含 Int32 值的元数据状态。 | | [XAppCaptureMetadataStartStringState](/reference/system/xappcapture/functions/xappcapturemetadatastartstringstate) | 向应用捕获添加一个包含字符串值的元数据状态。 | | [XAppCaptureMetadataStopAllStates](/reference/system/xappcapture/functions/xappcapturemetadatastopallstates) | 停止当前处于活动状态的所有状态事件。 | | [XAppCaptureMetadataStopState](/reference/system/xappcapture/functions/xappcapturemetadatastopstate) | 向应用捕获元数据添加针对特定命名状态的状态停止。 | | [XAppCaptureOpenScreenshotStream](/reference/system/xappcapture/functions/xappcaptureopenscreenshotstream) | 打开屏幕截图流。 | | [XAppCaptureReadLocalStream](/reference/system/xappcapture/functions/xappcapturereadlocalstream) | 读取先前调用 [XAppCaptureRecordTimespan](/reference/system/xappcapture/functions/xappcapturerecordtimespan) 生成的 .mp4 文件的内容。 | | [XAppCaptureReadScreenshotStream](/reference/system/xappcapture/functions/xappcapturereadscreenshotstream) | 读取屏幕截图流。 | | [XAppCaptureRecordDiagnosticClip](/reference/system/xappcapture/functions/xappcapturerecorddiagnosticclip) | 从应用中录制诊断剪辑。 | | [XAppCaptureRecordTimespan](/reference/system/xappcapture/functions/xappcapturerecordtimespan) | 进行 GameDVR 录制。 | | [XAppCaptureRegisterMetadataPurged](/reference/system/xappcapture/functions/xappcaptureregistermetadatapurged) | 为元数据清除事件注册事件处理程序。 | | [XAppCaptureStartUserRecord](/reference/system/xappcapture/functions/xappcapturestartuserrecord) | 如同用户触发的一样开始录制。 | | [XAppCaptureStopUserRecord](/reference/system/xappcapture/functions/xappcapturestopuserrecord) | 停止并保存通过 [XAppCaptureStartUserRecord](/reference/system/xappcapture/functions/xappcapturestartuserrecord) 启动、由输入的 ID 指定的正在进行的用户录制。 | | [XAppCaptureTakeDiagnosticScreenshot](/reference/system/xappcapture/functions/xappcapturetakediagnosticscreenshot) | 从应用截取诊断屏幕截图。 | | [XAppCaptureTakeScreenshot](/reference/system/xappcapture/functions/xappcapturetakescreenshot) | 截取屏幕截图。 | | [XAppCaptureUnRegisterMetadataPurged](/reference/system/xappcapture/functions/xappcaptureunregistermetadatapurged) | 移除元数据清除事件的事件处理程序。 | ## 结构体 | 结构体 | 说明 | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | | [XAppBroadcastStatus](/reference/system/xappcapture/structs/xappbroadcaststatus) | 描述应用/游戏广播能力的状态。 | | [XAppCaptureDiagnosticScreenshotResult](/reference/system/xappcapture/structs/xappcapturediagnosticscreenshotresult) | 应用捕获屏幕截图及描述性信息。 | | [XAppCaptureLocalResult](/reference/system/xappcapture/structs/xappcapturelocalresult) | 包含调用 XAppCaptureRecordTimespan 的结果。 | | [XAppCaptureRecordClipResult](/reference/system/xappcapture/structs/xappcapturerecordclipresult) | 捕获的视频剪辑及描述性信息。 | | [XAppCaptureScreenshotFile](/reference/system/xappcapture/structs/xappcapturescreenshotfile) | 捕获的屏幕截图及描述性信息。 | | [XAppCaptureScreenshotStream](/reference/system/xappcapture/structs/xappcapturescreenshotstream) | 表示屏幕截图流。 | | [XAppCaptureTakeScreenshotResult](/reference/system/xappcapture/structs/xappcapturetakescreenshotresult) | 表示截取屏幕截图的结果。 | | [XAppCaptureUserRecordingResult](/reference/system/xappcapture/structs/xappcaptureuserrecordingresult) | 包含调用 [XAppCaptureStopUserRecord](/reference/system/xappcapture/functions/xappcapturestopuserrecord) 的结果。 | | [XAppCaptureVideoCaptureSettings](/reference/system/xappcapture/structs/xappcapturevideocapturesettings) | GameDVR 视频捕获设置。 | ## 枚举 | 枚举 | 说明 | | ------------------------------------------------------------------------------------------------------ | -------------------------------------------- | | [XAppCaptureMetadataPriority](/reference/system/xappcapture/enums/xappcapturemetadatapriority) | 应用捕获元数据的优先级级别。用于在实施存储约束且必须删除某些元数据时确定哪些数据最重要。 | | [XAppCaptureScreenshotFormatFlag](/reference/system/xappcapture/enums/xappcapturescreenshotformatflag) | 确定屏幕截图捕获的清晰度质量。 | | [XAppCaptureVideoColorFormat](/reference/system/xappcapture/enums/xappcapturevideocolorformat) | 在 GameDVR 录制中使用的颜色格式。 | | [XAppCaptureVideoEncoding](/reference/system/xappcapture/enums/xappcapturevideoencoding) | 确定视频捕获的视频编码类型。 | ## Conceptual documentation * [Game DVR 和广播](/build/console-features/game-dvr/gamedvr-broadcast) * [时间敏感线程](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](/reference/system/xappcapture/xappcapture_errors)\ [系统 API 参考](/reference/system/gc-reference-system-toc) ## Related topics - [XAppCapture Error Codes](/zh-CN/reference/system/xappcapture/xappcapture_errors.md) - [XAppCaptureVideoCaptureSettings](/zh-CN/reference/system/xappcapture/structs/xappcapturevideocapturesettings.md) - [XAppCaptureMetadataPriority](/zh-CN/reference/system/xappcapture/enums/xappcapturemetadatapriority.md) - [XAppCaptureTakeScreenshot](/zh-CN/reference/system/xappcapture/functions/xappcapturetakescreenshot.md) - [XAppCaptureGetVideoCaptureSettings](/zh-CN/reference/system/xappcapture/functions/xappcapturegetvideocapturesettings.md)