Método IAudioSessionControl::SetGroupingParam (audiopolicy.h)

O método SetGroupingParam atribui uma sessão a um agrupamento de sessões.

Sintaxe

HRESULT SetGroupingParam(
  [in] LPCGUID Override,
  [in] LPCGUID EventContext
);

Parâmetros

[in] Override

O novo parâmetro de agrupamento. Esse parâmetro deve ser um ponteiro válido, não NULL , para um GUID de parâmetro de agrupamento. Para obter mais informações, consulte Comentários.

[in] EventContext

Ponteiro para o GUID de contexto de evento. Se uma chamada para esse método gerar um evento de alteração de agrupamento, 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 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
E_POINTER	O agrupamento de parâmetros é NULL.
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 não estão disponíveis para uso.
AUDCLNT_E_SERVICE_NOT_RUNNING	O serviço de áudio do Windows não está em execução.

Comentários

Um cliente chama esse método para alterar o parâmetro de agrupamento de uma sessão. Todas as sessões de áudio que têm o mesmo valor de parâmetro de agrupamento estão sob o controle do mesmo controle deslizante de nível de volume no programa de controle de volume do sistema, Sndvol. Para obter mais informações, consulte Parâmetros de agrupamento.

O cliente pode obter o parâmetro de agrupamento atual para a sessão chamando o método IAudioSessionControl::GetGroupingParam .

Se um cliente nunca tiver chamado SetGroupingParam para atribuir um parâmetro de agrupamento a uma sessão, a sessão não pertencerá a nenhum agrupamento. Uma sessão que não pertence a nenhum agrupamento tem seu próprio controle deslizante de nível de volume dedicado no programa Sndvol.

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	audiopolicy.h

Confira também

IAudioSessionControl Interface

IAudioSessionControl::GetGroupingParam

IAudioSessionEvents Interface