XAppCaptureMetadataStopState

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

Syntax

HRESULT XAppCaptureMetadataStopState(  
         const char* name  
)

name _In_z_
Type: char*

Name of the state to be stopped.

Type: HRESULT

Function result.

Note

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.

Header: XAppCapture.h

Library: xgameruntime.lib

Supported platforms: Windows, Xbox One family consoles and Xbox Series consoles