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

  • Article

Définit un multiplicateur d’amplitude audio qui sera appliqué aux données audio fournies par ISpatialAudioObject avant leur envoi au moteur de rendu audio.

Syntaxe

HRESULT SetVolume(
  [in] float volume
);

Paramètres

[in] volume

Multiplicateur d’amplitude pour les données audio. Il doit s’agir d’une valeur comprise entre 0,0 et 1,0.

Valeur retournée

Si la méthode réussit, retourne S_OK. En cas d’échec, les codes de retour possibles incluent, sans s’y limiter, les valeurs indiquées dans le tableau suivant.

Code de retour Description
SPTLAUDCLNT_E_OUT_OF_ORDER

ISpatialAudioObjectRenderStreamBase::BeginUpdatingAudioObjects n’a pas été appelé avant l’appel à SetVolume.
SPTLAUDCLNT_E_RESOURCES_INVALIDATED

SetEndOfStream a été appelé explicitement ou implicitement dans un passe de traitement audio précédent. SetEndOfStream est appelé implicitement par le système si GetBuffer n’est pas appelé dans un passe de traitement audio (entre les appels à ISpatialAudioObjectRenderStreamBase::BeginUpdatingAudioObjects et ISpatialAudioObjectRenderStreamBase::EndUpdatingAudioObjects).

Remarques

Si SetVolume n’est jamais appelé, la valeur par défaut 1.0 est utilisée. Une fois que SetVolume est appelé, le volume défini est utilisé pour l’objet audio jusqu’à ce que le volume soit modifié avec un autre appel à SetVolume.

Configuration requise

   
Plateforme cible Windows
En-tête spatialaudioclient.h

Voir aussi

ISpatialAudioObject