通过

XAppCaptureMetadataAddStringEvent

  • 项目

将具有字符串值的元数据事件添加到应用程序捕获。

语法

HRESULT XAppCaptureMetadataAddStringEvent(  
         const char* name,  
         const char* value,  
         XAppCaptureMetadataPriority priority  
)

参数

name _In_z_
类型：char*

要添加到应用程序捕获时间线的事件的名称。

value _In_z_
类型：char*

要添加到时间线的事件的值。 必须为字符串。

priority _In_
类型：XAppCaptureMetadataPriority

元数据的优先级。 用于确定在超过存储限制的情况下保存哪些内容。 XAppCaptureMetaDataPriority 枚举的成员。

返回值

类型：HRESULT

函数结果。

备注

注意

在时间敏感线程上调用此函数是不安全的。 有关详细信息，请参阅时间敏感线程。

调用此方法时，系统会将元数据事件与时间戳关联。 此元数据用于标识实时流期间的事件以及捕获的播放以分类和搜索内容。 要存储应用到时间窗口的字符串值，请使用 XAppCaptureMetaDataStartStringState。

注意

元数据可能上传到 Xbox Live 和/或保存到 .mp4 文件、屏幕截图或在广播期间使用，因此，绝不应使用元数据来记录用户私人信息。

要求

头文件：XAppCapture.h

库：xgameruntime.lib

支持平台：Windows、Xbox One 系列主机和 Xbox Series 主机

另请参阅

GameDVR 概述
XAppCapture 成员
XAppCaptureMetadataAddDoubleEvent
XAppCaptureMetadataAddInt32Event