Share via


ISpatialAudioObject::SetVolume-Methode (spatialaudioclient.h)

Legt einen Audioamplitudemultiplikator fest, der auf die vom ISpatialAudioObject bereitgestellten Audiodaten angewendet wird, bevor er an die Audiorendering-Engine übermittelt wird.

Syntax

HRESULT SetVolume(
  [in] float volume
);

Parameter

[in] volume

Der Amplitudenmultiplikator für Audiodaten. Dies muss ein Wert zwischen 0,0 und 1,0 sein.

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 SetVolume 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

Wenn SetVolume nie aufgerufen wird, wird der Standardwert 1.0 verwendet. Nachdem SetVolume aufgerufen wurde, wird das festgelegte Volume für das Audioobjekt verwendet, bis das Volume mit einem weiteren Aufruf von SetVolume geändert wird.

Anforderungen

   
Zielplattform Windows
Kopfzeile spatialaudioclient.h

Weitere Informationen

ISpatialAudioObject