Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

IMFClockStateSink::OnClockStop method

Called when the presentation clock stops.

Syntax


HRESULT OnClockStop(
  [in]  MFTIME hnssSystemTime
);

Parameters

hnssSystemTime [in]

The system time when the clock stopped, in 100-nanosecond units.

Return value

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

Return codeDescription
S_OK

The method succeeded.

MF_E_SINK_ALREADYSTOPPED

Deprecated. Do not use this error code.

 

Remarks

When the presentation clock's IMFPresentationClock::Stop method is called, the clock notifies the presentation time source by calling the presentation time source's OnClockStop method. This call occurs synchronously within the Stop method. If the time source returns an error from OnClockStop, the presentation clock's Stop method returns an error and the state change does not take place.

For any object that is not the presentation time source, the OnClockStop method is called asynchronously, after the state change is completed.

If an object is already stopped, it should return S_OK from OnClockStop. It should not return an error code.

Note  Although the header file mferror.h defines an error code named MF_E_SINK_ALREADYSTOPPED, it should not be returned in this situation.

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

See also

Presentation Clock
IMFClockStateSink
MFTIME

 

 

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.