IFilterChain::PauseChain 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 PauseChain method switches all the filters in a filter chain into a paused state.

Syntax

HRESULT PauseChain(
  [in] IBaseFilter *pStartFilter,
  [in] IBaseFilter *pEndFilter
);

Parameters

[in] pStartFilter

A pointer to the IBaseFilter interface of the filter at the start of the chain.

[in] pEndFilter

A pointer to the IBaseFilter interface of the filter at the end of the chain. If this parameter is NULL, the method uses the longest possible filter chain that extends downstream from the start filter.

Return value

Returns S_OK if successful. If the method fails, the return value may be VFW_E_NOT_PAUSED or another HRESULT value.

Remarks

If this method cannot switch a given filter into a paused state, it stops all of the filters in chain. The filter graph must be paused when you call this method.

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