IReferenceClockTimerControl::GetDefaultTimerResolution method (strmif.h)

[The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, IMFMediaEngine, and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

The GetDefaultTimerResolution method returns the timer resolution that was requested by the reference clock.

Syntax

HRESULT GetDefaultTimerResolution(
  [out] REFERENCE_TIME *pTimerResolution
);

Parameters

[out] pTimerResolution

Receives the requested timer resolution, in 100-nanosecond units.

Return value

Returns an HRESULT value. Possible values include the following.

Return code Description
S_OK
Success.
E_POINTER
NULL pointer argument.

Remarks

The value returned in pTimerResolution is the period that the reference clock attempts to set on the underlying timer. The actual timer period might differ, depending on the hardware. If the reference clock did not request a minimum timer resolution, the pTimerResolution parameter receives the value zero.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header strmif.h (include Dshow.h)
Library Strmiids.lib

See also

Error and Success Codes

IReferenceClockTimerControl Interface