IAMGraphStreams::SetMaxGraphLatency method (strmif.h)

Article
07/27/2023

[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 SetMaxGraphLatency method sets the maximum latency for the graph. You must call the IAMGraphStreams::SyncUsingStreamOffset method before calling this method.

Syntax

HRESULT SetMaxGraphLatency(
  [in] REFERENCE_TIME rtMaxGraphLatency
);

Parameters

[in] rtMaxGraphLatency

Specifies the maximum latency in 100-nanosecond units.

Return value

Returns an HRESULT value. Possible values include the following.

Return code	Description
E_FAIL	Failure
S_OK	Success

Remarks

At connection time, some live source filters use the maximum latency to determine the size of buffer to allocate. Calling this method before constructing the graph can help to ensure that sufficient buffers are allocated for the expected latency.

If you call this method before calling SyncUsingStreamOffset, the method returns E_FAIL.

Requirements

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