CBaseStreamControl.Flushing 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 Flushing method notifies the base class that the pin has started or stopped flushing.

Syntax

void Flushing(
   BOOL bInProgress
);

Parameters

bInProgress

Specifies a Boolean value that indicates whether the pin is flushing. Use the value TRUE when the pin begins a flush operation, and FALSE when the pin ends a flush operation.

Return value

This method does not return a value.

Remarks

The pin must call this method from within its IPin::BeginFlush and IPin::EndFlush methods. Specify TRUE in BeginFlush and FALSE in EndFlush.

This method causes the CBaseStreamControl::CheckStreamState method to stop waiting. While the pin is flushing, CheckStreamState always returns STREAM_DISCARDING.

Requirements

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

See also

CBaseStreamControl Class