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

  • Artigo

O método SetMasterVolume define o nível de volume master para a sessão de áudio.

Sintaxe

HRESULT SetMasterVolume(
  [in] float   fLevel,
  [in] LPCGUID EventContext
);

Parâmetros

[in] fLevel

O novo master nível de volume. Os níveis de volume válidos estão no intervalo de 0,0 a 1,0.

[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 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 .

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_INVALIDARG
 O parâmetro fLevel não está no intervalo de 0,0 a 1,0.
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

Esse método gera um evento de alteração de volume somente se a chamada de método alterar o nível de volume da sessão. Por exemplo, se o nível de volume for 0,4 quando a chamada ocorrer e a chamada definir o nível de volume como 0,4, nenhum evento será gerado.

Requisitos

Requisito Valor
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

ISimpleAudioVolume Interface

ISimpleAudioVolume::GetMasterVolume