Méthode ISpatialAudioObjectForHrtf ::SetGain (spatialaudiohrtf.h)

Définit le gain pour ISpatialAudioObjectForHrtf dans dB.

Syntaxe

HRESULT SetGain(
  [in] float gain
);

Paramètres

[in] gain

Gain pour ISpatialAudioObjectForHrtf en dB.

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 à SetGain.
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

Cela est valide uniquement pour les objets audio spatiaux configurés pour utiliser le type de désintégration SpatialAudioHrtfDistanceDecay_CustomDecay . Définissez le type de désintégration d’un objet ISpatialAudioObjectForHrtf en appelant SetDistanceDecay. Définissez le type de désintégration par défaut pour tous les objets d’un flux de rendu HRTF en définissant le champ DistanceDecay du SpatialAudioHrtfActivationParams passé dans ISpatialAudioClient ::ActivateSpatialAudioStream.

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

Configuration requise

Condition requise	Valeur
Plateforme cible	Windows
En-tête	spatialaudiohrtf.h

Voir aussi

ISpatialAudioObjectForHrtf