Skip to main content

XAppCaptureMetadataAddDoubleEvent

Add a metadata event with a double 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_
Type: double
Value of the event being added to the timeline. Must be a double. 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.
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 a double value that applies to a window of time, use XAppCaptureMetaDataStartDoubleState. Double values used with this function must be finite. Non-finite doubles will be converted into 0 and accepted.
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

Conceptual documentation

See also

GameDVR Overview
XAppCapture Members
XAppCaptureMetadataAddInt32Event
XAppCaptureMetadataAddStringEvent
Last modified on August 20, 2026