CBaseInputPin.EndFlush method

[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 EndFlush method ends a flush operation. Implements the IPin::EndFlush method.

Syntax

HRESULT EndFlush();

Parameters

This method has no parameters.

Return value

Returns S_OK.

Remarks

This method sets the CBaseInputPin::m_bFlushing flag to TRUE, which enables the CBaseInputPin::Receive method to accept samples.

The derived class must override this method and perform the following steps:

  1. Free any buffered data and wait for all queued samples to be discarded.
  2. Clear any pending EC_COMPLETE notifications.
  3. Call the base class method.
  4. Call IPin::EndFlush on downstream input pins. If the pin has not yet delivered any media samples downstream, you can skip this step. If your output pins derive from the CBaseOutputPin class, you can call the CBaseOutputPin::DeliverEndFlush method.

Requirements

Requirement Value
Header
Amfilter.h (include Streams.h)
Library
Strmbase.lib (retail builds);
Strmbasd.lib (debug builds)

See also

CBaseInputPin Class