IXStudioPlayback::SetPausePoint Method

Important The XStudio native C nano-COM APIs have been deprecated in favor of the KStudio native C nano-COM APIs.
Sets the playback pause point.

Syntax

public:
HRESULT SetPausePoint(
         UINT64 tick
)  

Parameters

tick
Type: UINT64 

[in] Tick count to set as the pause point. To clear the pause point, use XSTUDIO_TICK_INVALID.

Return value

Type: HRESULT 

S_OK if successful; an error code otherwise.

Remarks

The pause point is the tick position in the playback that, when reached, will cause playback to pause.

To pause playback at the current position instead, call Pause.

Requirements

Header: Declared in xstudio.h.

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

See also

IXStudioPlayback::GetPausePoint Method