Метод ISpatialAudioObjectForHrtf::SetGain (spatialaudiohrtf.h)

Задает прирост для ISpatialAudioObjectForHrtf в дБ.

Синтаксис

HRESULT SetGain(
  [in] float gain
);

Параметры

[in] gain

Увеличение для ISpatialAudioObjectForHrtf в дБ.

Возвращаемое значение

Если метод завершается успешно, возвращает значение S_OK. В случае сбоя возможные коды возврата включают, помимо прочего, значения, показанные в следующей таблице.

Код возврата	Описание
SPTLAUDCLNT_E_OUT_OF_ORDER	ISpatialAudioObjectRenderStreamBase::BeginUpdatingAudioObjects не был вызван до вызова SetGain.
SPTLAUDCLNT_E_RESOURCES_INVALIDATED	Метод SetEndOfStream был вызван явно или неявно в предыдущем проходе обработки звука. Метод SetEndOfStream вызывается системой неявно, если Метод GetBuffer не вызывается в пределах прохода обработки звука (между вызовами ISpatialAudioObjectRenderStreamBase::BeginUpdatingAudioObjects и ISpatialAudioObjectRenderStreamBase::EndUpdatingAudioObjects).

Комментарии

Это допустимо только для пространственных звуковых объектов, настроенных для использования типа SpatialAudioHrtfDistanceDecay_CustomDecay распада. Задайте тип распада объекта ISpatialAudioObjectForHrtf , вызвав Метод SetDistanceDecay. Задайте тип распада по умолчанию для всех объектов в потоке отрисовки HRTF, задав поле DistanceDecayобъекта SpatialAudioHrtfActivationParams, переданного в ISpatialAudioClient::ActivateSpatialAudioStream.

Если SetGain не вызывается, используется значение по умолчанию 0,0. После вызова SetGain заданное значение усиления будет использоваться для звукового объекта до тех пор, пока он не изменится при другом вызове SetGain.

Требования

Требование	Значение
Целевая платформа	Windows
Header	spatialaudiohrtf.h

См. также раздел

ISpatialAudioObjectForHrtf