IAudioSessionControl::GetState-Methode (audiopolicy.h)
Die GetState-Methode ruft den aktuellen Zustand der Audiositzung ab.
Syntax
HRESULT GetState(
[out] AudioSessionState *pRetVal
);
Parameter
[out] pRetVal
Zeiger auf eine Variable, in die die -Methode den aktuellen Sitzungszustand schreibt. Der Zustand muss einer der folgenden AudioSessionState-Enumerationswerte sein:
AudioSessionStateActive
AudioSessionStateInactive
AudioSessionStateExpired
Diese Werte geben an, dass der Sitzungszustand aktiv, inaktiv oder abgelaufen ist. Weitere Informationen finden Sie in den Hinweisen.
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 |
|---|---|
|
Der Parameter pRetVal ist NULL. |
|
Das Audioendpunktgerät wurde getrennt, oder die Audiohardware oder die zugehörigen Hardwareressourcen wurden neu konfiguriert, deaktiviert, entfernt oder anderweitig für die Verwendung nicht verfügbar gemacht. |
|
Der Windows-Audiodienst wird nicht ausgeführt. |
Hinweise
Diese Methode gibt an, ob der Zustand der Sitzung aktiv, inaktiv oder abgelaufen ist. Der Status ist aktiv, wenn die Sitzung über einen oder mehrere Streams verfügt, die ausgeführt werden. Der Status wechselt von aktiv zu inaktiv, wenn der letzte ausgeführte Stream in der Sitzung beendet wird. Der Sitzungsstatus ändert sich in abgelaufen, wenn der Client den letzten Stream in der Sitzung zerstört, indem alle Verweise auf das Streamobjekt freigegeben werden.
Das Sndvol-Programm zeigt Lautstärke- und Stummschaltungssteuerelemente für Sitzungen im aktiven und inaktiven Zustand an. Wenn eine Sitzung abläuft, zeigt Sndvol die Steuerelemente für diese Sitzung nicht mehr an. Wenn eine Sitzung zuvor abgelaufen ist, der Sitzungsstatus jedoch in aktiv (weil ein Stream in der Sitzung ausgeführt wird) oder inaktiv (weil ein Client der Sitzung einen neuen Stream zuweist), wird von Sndvol die Anzeige der Steuerelemente für die Sitzung fortgesetzt.
Der Client erstellt einen Stream durch Aufrufen der IAudioClient::Initialize-Methode . Bei der Erstellung eines Datenstroms weist der Client den Stream einer Sitzung zu. Eine Sitzung beginnt, wenn ein Client der Sitzung den ersten Stream zuweist. Zunächst befindet sich die Sitzung im inaktiven Zustand. Der Sitzungsstatus ändert sich in aktiv, wenn der erste Stream in der Sitzung mit der Ausführung beginnt. Die Sitzung wird beendet, wenn ein Client den letzten Verweis auf das letzte verbleibende Streamobjekt in der Sitzung freigibt.
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 | audiopolicy.h |