ISimpleAudioVolume::SetMute-Methode (audioclient.h)

  • Artikel

Die SetMute-Methode legt den Stummschaltungszustand für die Audiositzung fest.

Syntax

HRESULT SetMute(
  [in] const BOOL bMute,
  [in] LPCGUID    EventContext
);

Parameter

[in] bMute

Der neue Stummschaltungszustand. TRUE ermöglicht das Stummschalten. FALSE deaktiviert das Stummschalten.

[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
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 den Stummschaltungszustand der Sitzung von deaktiviert in aktiviert oder von aktiviert in deaktiviert ändert. Wenn beispielsweise das Stummschalten aktiviert ist, wenn der Aufruf erfolgt, und der Aufruf das Stummschalten aktiviert, wird kein Ereignis generiert.

Diese Methode wendet den gleichen Stummschaltungszustand auf alle Kanäle in der Audiositzung an. Das Endpunktgerät wendet das Stummschalten immer einheitlich für alle Kanäle in der Sitzung an. Es gibt keine IChannelAudioVolume-Methoden zum Festlegen der Stummschaltungszustände einzelner Kanäle.

Der Client kann den Stummschaltungszustand der Audiositzung abrufen, indem er die SimpleAudioVolume::GetMute-Methode aufruft .

Anforderungen

   
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

IChannelAudioVolume-Schnittstelle

ISimpleAudioVolume-Schnittstelle

ISimpleAudioVolume::GetMute