> ## 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.

# XAppCaptureMetadataAddStringEvent

> XAppCaptureMetadataAddStringEvent

# XAppCaptureMetadataAddStringEvent

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

## 语法

```cpp theme={null}
HRESULT XAppCaptureMetadataAddStringEvent(  
         const char* name,  
         const char* value,  
         XAppCaptureMetadataPriority priority  
)  
```

### 参数

*name*   \_In\_z\_\
类型：char\*

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

*value*   \_In\_z\_\
类型：char\*

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

*priority*   \_In\_\
类型：[XAppCaptureMetadataPriority](https://docs.xbox.com/zh-CN/reference/system/xappcapture/enums/xappcapturemetadatapriority.md)

元数据的优先级。用于在超出存储限制时确定要保存的内容。是 [XAppCaptureMetaDataPriority](https://docs.xbox.com/zh-CN/reference/system/xappcapture/enums/xappcapturemetadatapriority.md) 枚举的一个成员。

### 返回值

类型：HRESULT

函数结果。

## 备注

> [!NOTE]
>
> 此函数不能在时间敏感线程上安全调用。有关详细信息，请参阅 [Time-sensitive threads](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/console-dev/overviews/threads/time-sensitive-threads)。

当调用此方法时，系统会将该元数据事件与时间戳关联。这些元数据用于在直播和捕获回放期间标识事件，以对内容进行分类和搜索。若要存储适用于某个时间窗口的字符串值，请使用 [XAppCaptureMetaDataStartStringState](https://docs.xbox.com/zh-CN/reference/system/xappcapture/functions/xappcapturemetadatastartstringstate.md)。

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

## 要求

**头文件：** XAppCapture.h

**库：** xgameruntime.lib

**支持的平台：** Windows、XBOX One 系列主机和 XBOX Series 主机

## 概念性文档

* [Time-sensitive threads](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/console-dev/overviews/threads/time-sensitive-threads)

## 另请参阅

[GameDVR 概览](https://docs.xbox.com/zh-CN/build/console-features/game-dvr/gamedvr-broadcast.md)\
[XAppCapture 成员](https://docs.xbox.com/zh-CN/reference/system/xappcapture/xappcapture_members.md)\
[XAppCaptureMetadataAddDoubleEvent](https://docs.xbox.com/zh-CN/reference/system/xappcapture/functions/xappcapturemetadataadddoubleevent.md)\
[XAppCaptureMetadataAddInt32Event](https://docs.xbox.com/zh-CN/reference/system/xappcapture/functions/xappcapturemetadatastartint32state.md)


## Related topics

- [XAppCaptureMetadataAddDoubleEvent](https://docs.xbox.com/zh-CN/reference/system/xappcapture/functions/xappcapturemetadataadddoubleevent.md)
- [XAppCaptureMetadataAddInt32Event](https://docs.xbox.com/zh-CN/reference/system/xappcapture/functions/xappcapturemetadataaddint32event.md)
- [XAppCaptureMetadataStartStringState](https://docs.xbox.com/zh-CN/reference/system/xappcapture/functions/xappcapturemetadatastartstringstate.md)
- [XAppCapture（API 内容）](https://docs.xbox.com/zh-CN/reference/system/xappcapture/xappcapture_members.md)
- [在 Unity 项目中使用 GDK API 的 C# 包装器](https://docs.xbox.com/zh-CN/build/gdk-and-engines/unity/unity-api-wrappers.md)