IMFPresentationClock::Stop method

Stops the presentation clock. While the clock is stopped, the clock time does not advance, and the clock's IMFPresentationClock::GetTime method returns zero.

Syntax

HRESULT Stop(

);

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 stopped.

Remarks

This method is valid when the clock is running or paused.

The presentation clock initiates the state change by calling IMFClockStateSink::OnClockStop 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 OnClockStop methods. These calls are made asynchronously.

Requirements

   
Minimum supported client Windows Vista [desktop apps | UWP apps]
Minimum supported server Windows Server 2008 [desktop apps | UWP apps]
Target Platform Windows
Header mfidl.h
Library Mfuuid.lib

See Also

IMFPresentationClock

Presentation Clock