CBaseRenderer.Stop 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 Stop method stops the filter.

Syntax

HRESULT Stop();

Parameters

This method has no parameters.

Return value

Returns S_OK.

Remarks

This method overrides the CBaseFilter::Stop method. It performs the following actions:

• Calls CBaseFilter::Stop.
• Decommits the allocator. (See IMemAllocator::Decommit.)
• Cancels any scheduled rendering and releases the streaming thread.
• Waits for any pending Receive call to complete.

Requirements

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

See also

CBaseRenderer Class