Método ISpatialAudioObject::SetVolume (spatialaudioclient.h)

Define um multiplicador de amplitude de áudio que será aplicado aos dados de áudio fornecidos pelo ISpatialAudioObject antes de serem enviados ao mecanismo de renderização de áudio.

Sintaxe

HRESULT SetVolume(
  [in] float volume
);

Parâmetros

[in] volume

O multiplicador de amplitude para dados de áudio. Deve ser um valor entre 0,0 e 1,0.

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
SPTLAUDCLNT_E_OUT_OF_ORDER	ISpatialAudioObjectRenderStreamBase::BeginUpdatingAudioObjects não foi chamado antes da chamada para SetVolume.
SPTLAUDCLNT_E_RESOURCES_INVALIDATED	SetEndOfStream foi chamado explicitamente ou implicitamente em uma passagem de processamento de áudio anterior. SetEndOfStream será chamado implicitamente pelo sistema se GetBuffer não for chamado dentro de uma passagem de processamento de áudio (entre chamadas para ISpatialAudioObjectRenderStreamBase::BeginUpdatingAudioObjects e ISpatialAudioObjectRenderStreamBase::EndUpdatingAudioObjects).

Comentários

Se SetVolume nunca for chamado, o valor padrão de 1,0 será usado. Depois que SetVolume for chamado, o volume definido será usado para o objeto de áudio até que o volume seja alterado com outra chamada para SetVolume.

Requisitos

Plataforma de Destino	Windows
Cabeçalho	spatialaudioclient.h

Confira também

ISpatialAudioObject