IAMClockSlave::SetErrorTolerance method (strmif.h)

Article
02/22/2024

[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 SetErrorTolerance method sets the audio renderer's rate-matching tolerance.

Syntax

HRESULT SetErrorTolerance(
  [in] DWORD dwTolerance
);

Parameters

[in] dwTolerance

Specifies the maximum tolerance, in milliseconds. The value must be from 1 to 1000, inclusive.

Return value

Returns an HRESULT value. Possible values include the following.

Return code	Description
E_FAIL	Failure.
S_OK	Success.
VFW_E_NOT_STOPPED	The filter graph is not stopped.

Remarks

Changing the tolerance has no effect unless the audio renderer is matching rates with a different clock. If the audio renderer is the reference clock, the audio is always synchronized to the clock (by definition).

This method fails if the filter graph is not stopped.

Requirements

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