IXStudioPlayback::SingleStep Method

Important The XStudio native C nano-COM APIs have been deprecated in favor of the KStudio native C nano-COM APIs.
Plays back a single event.

Syntax

public:
HRESULT SingleStep(
         const GUID &streamType
)  

Parameters

streamType
Type: GUID 

[in] GUID of the stream type to single-step. To single-step any stream type, use XSTUDIO_NULL_GUID.

Return value

Type: HRESULT 

S_OK if successful; an error code otherwise.

Remarks

SingleStep can be called only while playback is paused.

If streamTypeGuid is XSTUDIO_NULL_GUID, then the next event that matches any stream type is single-stepped. Otherwise, the next event that matches the specified stream type is single-stepped, and intervening events are skipped.

Requirements

Header: Declared in xstudio.h.

Library: Use xstudioclient.lib (console) or xstudioservice.lib (desktop).