ISpatialAudioObjectForHrtf::SetEnvironment メソッド (spatialaudiohrtf.h)

ISpatialAudioObjectForHrtf に対してオーディオが処理されるときにシミュレートされる音響環境の種類を設定します。

構文

HRESULT SetEnvironment(
  [in] SpatialAudioHrtfEnvironmentType environment
);

[in] environment

ISpatialAudioObjectForHrtf に対してオーディオが処理されるときにシミュレートされる音響環境の種類を指定する値。

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

リターンコード	説明
SPTLAUDCLNT_E_OUT_OF_ORDER	ISpatialAudioObjectRenderStreamBase::BeginUpdatingAudioObjects は、SetEnvironment を呼び出す前に呼び出されませんでした。
SPTLAUDCLNT_E_RESOURCES_INVALIDATED	SetEndOfStream は、以前のオーディオ処理パスで明示的または暗黙的に呼び出されました。 GetBuffer がオーディオ処理パス内で呼び出されない場合 (ISpatialAudioObjectRenderStreamBase::BeginUpdatingAudioObjects と ISpatialAudioObjectRenderStreamBase::EndUpdatingAudioObjects の呼び出しの間)、SetEndOfStream はシステムによって暗黙的に呼び出されます。

リターンコード

説明

ISpatialAudioObjectRenderStreamBase::BeginUpdatingAudioObjects は 、SetEnvironment を呼び出す前に呼び出されませんでした。

SetEndOfStream は、以前のオーディオ処理パスで明示的または暗黙的に呼び出されました。 GetBuffer がオーディオ処理パス内で呼び出されない場合 (ISpatialAudioObjectRenderStreamBase::BeginUpdatingAudioObjects と ISpatialAudioObjectRenderStreamBase::EndUpdatingAudioObjects の呼び出しの間)、SetEndOfStream はシステムによって暗黙的に呼び出されます。

SetEnvironment が呼び出されない場合は、SpatialAudioHrtfEnvironment_Smallの既定値が使用されます。

要件	値
対象プラットフォーム	Windows
ヘッダー	spatialaudiohrtf.h