Método ISimpleAudioVolume::SetMute (audioclient.h)

O método SetMute define o estado de mudo para a sessão de áudio.

Sintaxe

HRESULT SetMute(
  [in] const BOOL bMute,
  [in] LPCGUID    EventContext
);

Parâmetros

[in] bMute

O novo estado de ativação de mudo. TRUE habilita o mudo. FALSE desabilita o mudo.

[in] EventContext

Ponteiro para o GUID de contexto de evento. Se uma chamada para esse método gerar um evento de alteração de volume, o gerenciador de sessão enviará notificações a todos os clientes que registraram interfaces IAudioSessionEvents com o gerenciador de sessão. O gerenciador de sessão inclui o valor do ponteiro EventContext com cada notificação. Ao receber uma notificação, um cliente pode determinar se ele ou outro cliente é a origem do evento inspecionando o valor EventContext . Esse esquema depende do cliente selecionar um valor para esse parâmetro que é exclusivo entre todos os clientes na sessão. 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 .

Valor retornado

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
AUDCLNT_E_DEVICE_INVALIDATED
O dispositivo de ponto de extremidade de áudio foi desconectado ou o hardware de áudio ou os recursos de hardware associados foram reconfigurados, desabilitados, removidos ou indisponíveis para uso.
AUDCLNT_E_SERVICE_NOT_RUNNING
O serviço de áudio do Windows não está em execução.

Comentários

Esse método gerará um evento de alteração de volume somente se a chamada de método alterar o estado de ativação da sessão de desabilitado para habilitado ou de habilitado para desabilitado. Por exemplo, se o mudo estiver habilitado quando a chamada ocorrer e a chamada habilitar o mudo, nenhum evento será gerado.

Esse método aplica o mesmo estado de ativação de mudo a todos os canais na sessão de áudio. O dispositivo de ponto de extremidade sempre aplica o mudo uniformemente em todos os canais da sessão. Não há métodos IChannelAudioVolume para definir os estados de mudo de canais individuais.

O cliente pode obter o estado de mudo da sessão de áudio chamando o método SimpleAudioVolume::GetMute .

Requisitos

   
Cliente mínimo com suporte Windows Vista [aplicativos da área de trabalho | Aplicativos UWP]
Servidor mínimo com suporte Windows Server 2008 [aplicativos da área de trabalho | Aplicativos UWP]
Plataforma de Destino Windows
Cabeçalho audioclient.h

Confira também

IAudioSessionEvents Interface

IChannelAudioVolume Interface

ISimpleAudioVolume Interface

ISimpleAudioVolume::GetMute