Skip to main content

​
XAppCaptureMetadataStopState

Add a state stop for a particular named state to the app capture metadata.

​
Syntax

​
Parameters

name   _In_z_
Type: char* Name of the state to be stopped.

​
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.
Adding a stop state to the app capture timeline will mark the end of a previously started event. Events are started by one of the XappCaptureMetaDataStart*Event functions: XAppCaptureMetadataStartInt32State, XAppCaptureMetadataStartDoubleState, or XAppCaptureMetadataStartStringState. Stop state will only stop one state at a time, If you wish to stop all metadata states at once call XAppCaptureMetadataStopAllStates.

​
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
XAppCaptureMetadataStopAllStates
XAppCaptureMetadataStartInt32State
XAppCaptureMetadataStartDoubleState
XAppCaptureMetadataStopAllStates
Last modified on August 20, 2026