ISpatialAudioClient::IsSpatialAudioStreamAvailable method
[Some information relates to pre-released product which may be substantially modified before it's commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.]
When successful, gets a value indicating whether the currently active spatial rendering engine supports the specified spatial audio render stream.
Syntax
HRESULT IsSpatialAudioStreamAvailable( [in] REFIID streamUuid, [in, optional] const PROPVAR auxiliaryInfo );
Parameters
- streamUuid [in]
-
The interface ID of the interface for which availability is queried.
- auxiliaryInfo [in, optional]
-
A structure containing additional information to be used when support is queried. For more information, see Remarks.
Return value
If the method succeeds, it returns S_OK. If it fails, possible return codes include, but are not limited to, the values shown in the following table.
| Return code | Description |
|---|---|
|
The specified stream interface can't be activated by the currently active rendering engine. |
|
The metadata format supplied in the auxiliaryInfo parameter is not supported by the current rendering engine. For more information, see Remarks.. |
Remarks
When querying to see if the ISpatialAudioObjectRenderStreamForMetadata you can use the auxilaryInfo parameter to query if a particular metadata format is supported. The following code example demonstrates how to initialize the PROPVARIANT structure to check for support for an example metadata format.
PROPVARIANT auxiliaryInfo;
auxiliaryInfo.vt = VT_CLSID;
auxiliaryInfo.puuid = const_cast<CLSID*>(&CONTOSO_SPATIAL_METADATA_V1_0);
If the specified metadata format is unsupported, IsSpatialAudioStreamAvailable returns SPTLAUDCLNT_E_METADATA_FORMAT_IS_NOT_SUPPORTED.
Requirements
|
Header |
|
|---|
See also