Edit

Share via

IAudioAutoGainControl::SetEnabled method (devicetopology.h)

  • Article

The SetEnabled method enables or disables the AGC.

Syntax

HRESULT SetEnabled(
  [in] BOOL    bEnable,
  [in] LPCGUID pguidEventContext
);

Parameters

[in] bEnable

The new AGC state. If this parameter is TRUE (nonzero), the method enables AGC. If FALSE, it disables AGC.

[in] pguidEventContext

Context value for the IControlChangeNotify::OnNotify method. This parameter points to an event-context GUID. If the SetEnabled call changes the state of the AGC control, all clients that have registered IControlChangeNotify interfaces with that control receive notifications. In its implementation of the OnNotify method, a client can inspect the event-context GUID to discover whether it or another client is the source of the control-change event. If the caller supplies a NULL pointer for this parameter, the client's notification method receives a NULL context pointer.

Return value

If the method succeeds, it returns S_OK. If it fails, possible return codes include, but are not limited to, the values shown in the following table.

Return code Description
E_OUTOFMEMORY
 Out of memory.

Remarks

A disabled AGC control operates in pass-through mode. In this mode, the audio stream passes through the control without modification.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header devicetopology.h

See also

IAudioAutoGainControl Interface