Edit

IMFPresentationTimeSource::GetUnderlyingClock method (mfidl.h)

  • Article

Retrieves the underlying clock that the presentation time source uses to generate its clock times.

Syntax

HRESULT GetUnderlyingClock(
  [out] IMFClock **ppClock
);

Parameters

[out] ppClock

Receives a pointer to the clock's IMFClock interface. The caller must release the interface.

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_NO_CLOCK
 This time source does not expose an underlying clock.

Remarks

A presentation time source must support stopping, starting, pausing, and rate changes. However, in many cases the time source derives its clock times from a hardware clock or other device. The underlying clock is always running, and might not support rate changes.

Optionally, a time source can expose the underlying clock by implementing this method. The underlying clock is always running, even when the presentation time source is paused or stopped. (Therefore, the underlying clock returns the MFCLOCK_CHARACTERISTICS_FLAG_ALWAYS_RUNNING flag in the IMFClock::GetClockCharacteristics method).

The underlying clock is useful if you want to make decisions based on the clock times while the presentation clock is stopped or paused.

If the time source does not expose an underlying clock, the method returns MF_E_NO_CLOCK.

Requirements

Requirement Value
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

IMFPresentationTimeSource

Presentation Clock