CDynamicOutputPin.Active 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 Active method notifies the pin that the filter is now active.

Syntax

HRESULT Active();

Parameters

This method has no parameters.

Return value

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

Return code	Description
S_OK	Success.
E_FAIL	Failure. CDynamicOutputPin::SetConfigInfo was not called.

Remarks

This method overrides the CBaseOutputPin::Active method. It resets the CDynamicOutputPin::m_hStopEvent event. If the owning filter has not called SetConfigInfo, this method returns E_FAIL.

Requirements

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

See also

CDynamicOutputPin Class