ISpatialAudioClient::IsSpatialAudioStreamAvailable-Methode (spatialaudioclient.h)

  • Artikel

Ruft bei erfolgreicher Ausführung einen Wert ab, der angibt, ob die derzeit aktive Raumrendering-Engine den angegebenen räumlichen Audiorenderingstream unterstützt.

Syntax

HRESULT IsSpatialAudioStreamAvailable(
  [in]           REFIID            streamUuid,
  [in, optional] const PROPVARIANT *auxiliaryInfo
);

Parameter

[in] streamUuid

Die Schnittstellen-ID der Schnittstelle, für die die Verfügbarkeit abgefragt wird.

[in, optional] auxiliaryInfo

Eine Struktur, die zusätzliche Informationen enthält, die verwendet werden sollen, wenn die Unterstützung abgefragt wird. 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
SPTLAUDCLNT_E_STREAM_IS_NOT_AVAILABLE
 Die angegebene Streamschnittstelle kann von der derzeit aktiven Rendering-Engine nicht aktiviert werden.
SPTLAUDCLNT_E_METADATA_FORMAT_IS_NOT_SUPPORTED
 Das metadatenformat, das im hilfsinfo-Parameter angegeben wird, wird von der aktuellen Rendering-Engine nicht unterstützt. Weitere Informationen finden Sie unter Hinweise..

Hinweise

Wenn Sie abfragen, ob ISpatialAudioObjectRenderStreamForMetadata verwendet wird, können Sie den Parameter auxilaryInfo verwenden, um abzufragen, ob ein bestimmtes Metadatenformat unterstützt wird. Im folgenden Codebeispiel wird veranschaulicht, wie die PROPVARIANT-Struktur initialisiert wird, um die Unterstützung für ein Beispielmetadatenformat zu überprüfen.

PROPVARIANT auxiliaryInfo;  
auxiliaryInfo.vt = VT_CLSID;  
auxiliaryInfo.puuid = const_cast<CLSID*>(&CONTOSO_SPATIAL_METADATA_V1_0);

Wenn das angegebene Metadatenformat nicht unterstützt wird, gibt IsSpatialAudioStreamAvailable SPTLAUDCLNT_E_METADATA_FORMAT_IS_NOT_SUPPORTED zurück.

Anforderungen

   
Zielplattform Windows
Kopfzeile spatialaudioclient.h

Weitere Informationen

ISpatialAudioClient