COutputQueue.BeginFlush 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 BeginFlush method begins a flush operation.

Syntax

void BeginFlush();

Parameters

This method has no parameters.

Return value

This method does not return a value.

Remarks

This method sets the COutputQueue::m_bFlushing member variable to TRUE. If the object is using a thread, the thread calls the COutputQueue::FreeSamples method to free any pending samples. Otherwise, the object calls FreeSamples during the COutputQueue::EndFlush method. This method also sets the COutputQueue::m_hr member variable to S_FALSE, which causes the object to discard all new samples.

The object passes the flush notification downstream by calling the IPin::BeginFlush method on the input pin.

Requirements

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

See also

COutputQueue Class