Edit

Share via

ISpatialAudioClient::IsSpatialAudioStreamAvailable method (spatialaudioclient.h)

  • Article

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 PROPVARIANT *auxiliaryInfo
);

Parameters

[in] streamUuid

The interface ID of the interface for which availability is queried.

[in, optional] auxiliaryInfo

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
SPTLAUDCLNT_E_STREAM_IS_NOT_AVAILABLE
 The specified stream interface can't be activated by the currently active rendering engine.
SPTLAUDCLNT_E_METADATA_FORMAT_IS_NOT_SUPPORTED
 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

Requirement Value
Target Platform Windows
Header spatialaudioclient.h

See also

ISpatialAudioClient