ISimpleAudioVolume::SetMasterVolume-Methode (audioclient.h)

  • Artikel

Die SetMasterVolume-Methode legt den master Lautstärkepegel für die Audiositzung fest.

Syntax

HRESULT SetMasterVolume(
  [in] float   fLevel,
  [in] LPCGUID EventContext
);

Parameter

[in] fLevel

Die neue master Lautstärkeebene. Gültige Lautstärkestufen liegen im Bereich von 0,0 bis 1,0.

[in] EventContext

Zeiger auf die Ereigniskontext-GUID. Wenn ein Aufruf dieser Methode ein Volumeänderungsereignis generiert, sendet der Sitzungs-Manager Benachrichtigungen an alle Clients, die IAudioSessionEvents-Schnittstellen mit dem Sitzungs-Manager registriert haben. Der Sitzungs-Manager enthält den EventContext-Zeigerwert mit jeder Benachrichtigung. Beim Empfang einer Benachrichtigung kann ein Client ermitteln, ob er oder ein anderer Client die Quelle des Ereignisses ist, indem er den EventContext-Wert überprüft. Dieses Schema hängt davon ab, dass der Client einen Wert für diesen Parameter auswählt, der für alle Clients in der Sitzung eindeutig ist. Wenn der Aufrufer einen NULL-Zeiger für diesen Parameter bereitstellt, empfängt die Benachrichtigungsmethode des Clients einen NULL-Kontextzeiger .

Rückgabewert

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

Rückgabecode Beschreibung
E_INVALIDARG
 Der Parameter fLevel liegt nicht im Bereich von 0,0 bis 1,0.
AUDCLNT_E_DEVICE_INVALIDATED
 Das Audioendpunktgerät wurde nicht angeschlossen, oder die Audiohardware oder die zugehörigen Hardwareressourcen wurden neu konfiguriert, deaktiviert, entfernt oder anderweitig nicht mehr verfügbar gemacht.
AUDCLNT_E_SERVICE_NOT_RUNNING
 Der Windows-Audiodienst wird nicht ausgeführt.

Hinweise

Diese Methode generiert nur dann ein Volumeänderungsereignis, wenn der Methodenaufruf die Volumeebene der Sitzung ändert. Wenn die Volumeebene beispielsweise 0,4 ist, wenn der Aufruf erfolgt, und der Aufruf die Volumeebene auf 0,4 festlegt, wird kein Ereignis generiert.

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client) Windows Vista [Desktop-Apps | UWP-Apps]
Unterstützte Mindestversion (Server) Windows Server 2008 [Desktop-Apps | UWP-Apps]
Zielplattform Windows
Kopfzeile audioclient.h

Weitere Informationen

IAudioSessionEvents-Schnittstelle

ISimpleAudioVolume-Schnittstelle

ISimpleAudioVolume::GetMasterVolume