ISpatialAudioObjectForHrtf::SetGain-Methode (spatialaudiohrtf.h)

Legt den Gain für ISpatialAudioObjectForHrtf in dB fest.

Syntax

HRESULT SetGain(
  [in] float gain
);

Parameter

[in] gain

Der Gewinn für das ISpatialAudioObjectForHrtf in dB.

Rückgabewert

Wenn die Methode erfolgreich ist, wird S_OK zurückgegeben. Wenn ein Fehler auftritt, können mögliche Rückgabecodes die in der folgenden Tabelle gezeigten Werte umfassen, sind jedoch nicht darauf beschränkt.

Rückgabecode Beschreibung
SPTLAUDCLNT_E_OUT_OF_ORDER

ISpatialAudioObjectRenderStreamBase::BeginUpdatingAudioObjects wurde vor dem Aufruf von SetGain nicht aufgerufen.

SPTLAUDCLNT_E_RESOURCES_INVALIDATED

SetEndOfStream wurde in einem vorherigen Audioverarbeitungsdurchlauf explizit oder implizit aufgerufen. SetEndOfStream wird implizit vom System aufgerufen, wenn GetBuffer nicht innerhalb eines Audioverarbeitungsdurchlaufs aufgerufen wird (zwischen Aufrufen von ISpatialAudioObjectRenderStreamBase::BeginUpdatingAudioObjects und ISpatialAudioObjectRenderStreamBase:EndUpdatingAudioObjects).

Hinweise

Dies gilt nur für räumliche Audioobjekte, die für die Verwendung des SpatialAudioHrtfDistanceDecay_CustomDecay Verfallstyps konfiguriert sind. Legen Sie den Verfallstyp eines ISpatialAudioObjectForHrtf-Objekts fest, indem Sie SetDistanceDecay aufrufen. Legen Sie den Standardzerfalltyp für alle Objekte in einem HRTF-Renderstream fest, indem Sie das DistanceDecay-Feld der SpatialAudioHrtfActivationParams festlegen, die an ISpatialAudioClient::ActivateSpatialAudioStream übergeben werden.

Wenn SetGain nie aufgerufen wird, wird der Standardwert 0.0 verwendet. Nachdem SetGain aufgerufen wurde, wird die festgelegte Verstärkung für das Audioobjekt verwendet, bis die Verstärkung mit einem weiteren Aufruf von SetGain geändert wird.

Anforderungen

Anforderung Wert
Zielplattform Windows
Kopfzeile spatialaudiohrtf.h

Weitere Informationen

ISpatialAudioObjectForHrtf