IMediaFilter::Pause method

The Pause method pauses the filter.

Syntax


HRESULT Pause();

Parameters

This method has no parameters.

Return value

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

Return codeDescription
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. A renderer filter does not complete the transition to paused until either (1) it receives one sample, or (2) it receives an end-of-stream notification. While the state transition is pending, IMediaFilter::GetState returns VFW_S_STATE_INTERMEDIATE.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Strmif.h (include Dshow.h)

Library

Strmiids.lib

See also

IBaseFilter
Error and Success Codes
IMediaFilter Interface

 

 

Show: