XAppCaptureMetadataAddInt32Event

Article
11/09/2023

Add a metadata event with an Int32 value to your app capture.

Syntax

HRESULT XAppCaptureMetadataAddInt32Event(  
         const char* name,  
         int32_t value,  
         XAppCaptureMetadataPriority priority  
)

Parameters

name _In_z_
Type: char*

Name of the event being added to the app capture timeline.

value _In_
Type: int32_t

Value of the event being added to the timeline. Must be an Int32.

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

Note

This function isn't safe to call on a time-sensitive thread. For more information, see Time-sensitive threads.

The system associates a metadata event with a timestamp when this method is called. This metadata is used to identify events during live streams, and captured playback to categorize and search content. To store an integer value that applies to a window of time, use XAppCaptureMetaDataStartInt32State.

Note

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 consoles

Share via