IAMAudioInputMixer::get_Enable method (strmif.h)

[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 get_Enable method retrieves whether the input is enabled.

Syntax

HRESULT get_Enable(
  [out] BOOL *pfEnable
);

Parameters

[out] pfEnable

Receives one of the following values.

Value Description
TRUE Input is enabled.
FALSE Input is disabled.

Return value

Returns an HRESULT value. Possible values include the following.

Return code Description
S_OK
Success.
E_NOTIMPL
Not implemented.
E_POINTER
NULL pointer argument.

Remarks

This method applies to specific input pins on the Audio Capture Filter, so the filter itself returns E_NOTIMPL.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header strmif.h (include Dshow.h)
Library Strmiids.lib

See also

Error and Success Codes

IAMAudioInputMixer Interface

IAMAudioInputMixer::put_Enable