Skip to main content

XAppCaptureMetadataAddStringEvent

向应用捕获添加一个带字符串值的元数据事件。

语法

参数

name   _In_z_
类型:char*
要添加到应用捕获时间线的事件的名称。 value   _In_z_
类型:char*
要添加到时间线的事件的值。必须为字符串。 priority   _In_
类型:XAppCaptureMetadataPriority
元数据的优先级。用于在超出存储限制时确定要保存的内容。是 XAppCaptureMetaDataPriority 枚举的一个成员。

返回值

类型:HRESULT 函数结果。

备注

此函数不能在时间敏感线程上安全调用。有关详细信息,请参阅 Time-sensitive threads
当调用此方法时,系统会将该元数据事件与时间戳关联。这些元数据用于在直播和捕获回放期间标识事件,以对内容进行分类和搜索。若要存储适用于某个时间窗口的字符串值,请使用 XAppCaptureMetaDataStartStringState
元数据可能会上传到 XBOX Live 和/或保存到 .mp4 文件、屏幕截图,或在广播期间使用,因此绝不应将私人用户信息记录到元数据中。

要求

头文件: XAppCapture.h 库: xgameruntime.lib 支持的平台: Windows、XBOX One 系列主机和 XBOX Series 主机

概念性文档

另请参阅

GameDVR 概览
XAppCapture 成员
XAppCaptureMetadataAddDoubleEvent
XAppCaptureMetadataAddInt32Event
最后修改于 2026年8月24日