CBaseFilter.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. This method implements the IMediaFilter::Stop method.
Syntax
HRESULT Stop();
Parameters
This method has no parameters.
Return value
Returns S_OK if successful, or an HRESULT value indicating the cause of the error.
Remarks
This method calls the CBasePin::Inactive method on each of the filter's connected pins. It also sets the filter's state to State_Stopped.
When the filter stops, it should reject samples from upstream, stop delivering samples downstream, shut down worker threads, and free any resources that it used for streaming.
Requirements
| Requirement | Value |
|---|---|
| Header |
|
| Library |
|