IAudioAutoGainControl::SetEnabled 方法 (devicetopology.h)

SetEnabled 方法启用或禁用 AGC。

语法

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

参数

[in] bEnable

新的 AGC 状态。 如果此参数为 TRUE (非零) ,该方法将启用 AGC。 如果 为 FALSE,则禁用 AGC。

[in] pguidEventContext

IControlChangeNotify::OnNotify 方法的上下文值。 此参数指向事件上下文 GUID。 如果 SetEnabled 调用更改 AGC 控件的状态,则已注册具有该控件的 IControlChangeNotify 接口的所有客户端都会收到通知。 在 OnNotify 方法的实现中,客户端可以检查事件上下文 GUID,以发现它是还是另一个客户端是 control-change 事件的源。 如果调用方为此参数提供 NULL 指针,则客户端的通知方法将收到 NULL 上下文指针。

返回值

如果该方法成功,则它会返回 S_OK。 如果失败,可能的返回代码包括但不限于下表中显示的值。

返回代码 说明
E_OUTOFMEMORY
内存不足。

注解

禁用的 AGC 控件在传递模式下运行。 在此模式下,音频流无需修改即可通过 控件。

要求

要求
最低受支持的客户端 Windows Vista [仅限桌面应用]
最低受支持的服务器 Windows Server 2008 [仅限桌面应用]
目标平台 Windows
标头 devicetopology.h

另请参阅

IAudioAutoGainControl 接口