The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

IMFPresentationClock::Pause method

Pauses the presentation clock. While the clock is paused, the clock time does not advance, and the clock's IMFPresentationClock::GetTime returns the time at which the clock was paused.

Syntax

C++


HRESULT Pause();

Parameters

This method has no parameters.

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return code	Description
S_OK	The method succeeded.
MF_E_CLOCK_NO_TIME_SOURCE	No time source was set on this clock.
MF_E_CLOCK_STATE_ALREADY_SET	The clock is already paused.
MF_E_INVALIDREQUEST	The clock is stopped. This request is not valid when the clock is stopped.

Remarks

This method is valid when the clock is running. It is not valid when the clock is paused or stopped.

The presentation clock initiates the state change by calling IMFClockStateSink::OnClockPause on the clock's time source. This call is made synchronously. If it fails, the state change does not occur. If the call succeeds, the state changes, and the clock notifies the other state-change subscribers by calling their OnClockPause methods. These calls are made asynchronously.

Requirements

Minimum supported client	Windows Vista [desktop apps \| Windows Store apps]
Minimum supported server	Windows Server 2008 [desktop apps \| Windows Store apps]
Header	Mfidl.h
Library	Mfuuid.lib