Share via


Método IAudioAutoGainControl::SetEnabled (devicetopology.h)

O método SetEnabled habilita ou desabilita o AGC.

Sintaxe

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

Parâmetros

[in] bEnable

O novo estado do AGC. Se esse parâmetro for TRUE (diferente de zero), o método habilitará o AGC. Se FALSE, ele desabilita o AGC.

[in] pguidEventContext

Valor de contexto para o método IControlChangeNotify::OnNotify . Esse parâmetro aponta para um GUID de contexto de evento. Se a chamada SetEnabled alterar o estado do controle AGC, todos os clientes que registraram interfaces IControlChangeNotify com esse controle receberão notificações. Em sua implementação do método OnNotify , um cliente pode inspecionar o GUID de contexto de evento para descobrir se ele ou outro cliente é a origem do evento control-change. Se o chamador fornecer um ponteiro NULL para esse parâmetro, o método de notificação do cliente receberá um ponteiro de contexto NULL .

Retornar valor

Se o método for bem-sucedido, retornará S_OK. Se falhar, os códigos de retorno possíveis incluem, mas não se limitam a, os valores mostrados na tabela a seguir.

Código de retorno Descrição
E_OUTOFMEMORY
Sem memória.

Comentários

Um controle AGC desabilitado opera no modo de passagem. Nesse modo, o fluxo de áudio passa pelo controle sem modificação.

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows Vista [somente aplicativos da área de trabalho]
Servidor mínimo com suporte Windows Server 2008 [somente aplicativos da área de trabalho]
Plataforma de Destino Windows
Cabeçalho devicetopology.h

Confira também

IAudioAutoGainControl Interface