Edit

Share via

CBaseRenderer.Pause method

  • Article

[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 Pause method pauses the filter.

Syntax

HRESULT Pause();

Parameters

This method has no parameters.

Return value

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

Return code Description
S_OK
 The transition is complete.
S_FALSE
 Transition is not complete.

Remarks

This method overrides the CBaseFilter::Pause method. It performs the following steps:

  • Calls the CBaseFilter::Pause method.
  • Commits the allocator. (See IMemAllocator::Commit.)
  • If the previous state was stopped, the filter releases any sample it is holding. (The sample is no longer valid.)
  • Calls the CBaseRenderer::CompleteStateChange method and returns the value.

Requirements

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

See also

CBaseRenderer Class