XAppCaptureMetadataAddStringEvent
Add a metadata event with a string value to your app capture.Syntax
Parameters
name _In_z_Type: char* Name of the event being added to the app capture timeline. value _In_z_
Type: char* Value of the event being added to the timeline. Must be a string. priority _In_
Type: XAppCaptureMetadataPriority Priority of the metadata. Used to determine what is saved in the case that storage limiters are exceeded. A member of the XAppCaptureMetaDataPriority enumeration.
Return value
Type: HRESULT Function result.Remarks
This function isn’t safe to call on a time-sensitive thread. For more information, see Time-sensitive threads.
Metadata may be uploaded to XBOX Live and/or saved to .mp4 files, screenshots or used during broadcast, as such, private user info should never be logged with meta data.
Requirements
Header: XAppCapture.h Library: xgameruntime.lib Supported platforms: Windows, XBOX One family consoles and XBOX Series consolesConceptual documentation
See also
GameDVR OverviewXAppCapture Members
XAppCaptureMetadataAddDoubleEvent
XAppCaptureMetadataAddInt32Event