IMediaFilter::Pause

 
Microsoft DirectShow 9.0

IMediaFilter::Pause

The Pause method pauses the filter.

Syntax

  HRESULT Pause(void);

Return Values

Returns an HRESULT value. Possible values include those shown in the following table.

Return code Description
S_FALSE Transition is not complete.
S_OK Success. Transition is complete.

Remarks

When a filter is paused, it can receive, process, and deliver samples. However, a renderer filter will only accept one sample while paused. Therefore, when the filter graph is paused, samples move through the graph until the first sample reaches the renderer. At that point, streaming is paused until the IMediaFilter::Run method is called. Video renderers display the first sample as a still frame.

Live capture filters do not deliver any samples while paused, only while running.

The state transition might be asynchronous. If the method returns before the transition completes, the return value is S_FALSE. Renderer filters do not complete the state transition until they receive one sample.

Requirements

Header: Declared in Strmif.h; include Dshow.h.

Library: Use Strmiids.lib.

See Also