ISpatialAudioClient::IsSpatialAudioStreamAvailable メソッド (spatialaudioclient.h)

  • [アーティクル]

成功した場合、現在アクティブな空間レンダリング エンジンが指定された空間オーディオ レンダリング ストリームをサポートするかどうかを示す値を取得します。

構文

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

パラメーター

[in] streamUuid

可用性の照会対象となるインターフェイスのインターフェイス ID。

[in, optional] auxiliaryInfo

サポートの照会時に使用される追加情報を含む構造体。 詳細については、「解説」を参照してください。

戻り値

メソッドが成功した場合は、S_OK を返します。 エラーが発生した場合、次の表に示す値が、可能なリターン コードに含まれますが、これらに限定されません。

リターン コード 説明
SPTLAUDCLNT_E_STREAM_IS_NOT_AVAILABLE
 指定されたストリーム インターフェイスは、現在アクティブなレンダリング エンジンによってアクティブ化できません。
SPTLAUDCLNT_E_METADATA_FORMAT_IS_NOT_SUPPORTED
 auxiliaryInfo パラメーターで指定されたメタデータ形式は、現在のレンダリング エンジンではサポートされていません。 詳細については、「解説」を参照してください。

解説

ISpatialAudioObjectRenderStreamForMetadata を照会するときに、auxilaryInfo パラメーターを使用して、特定のメタデータ形式がサポートされているかどうかを照会できます。 次のコード例では、PROPVARIANT 構造体を初期化して、メタデータ形式の例をサポートするためにチェックする方法を示します。

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

指定したメタデータ形式がサポートされていない場合、 IsSpatialAudioStreamAvailable はSPTLAUDCLNT_E_METADATA_FORMAT_IS_NOT_SUPPORTEDを返します。

必要条件

   
対象プラットフォーム Windows
ヘッダー spatialaudioclient.h

関連項目

ISpatialAudioClient