ISpatialAudioObject::SetVolume メソッド (spatialaudioclient.h)

オーディオレンダリングエンジンに送信される前に ISpatialAudioObject によって提供されるオーディオデータに適用されるオーディオ振幅乗数を設定します。

構文

HRESULT SetVolume(
  [in] float volume
);

[in] volume

オーディオデータの振幅乗数。これは 0.0 ~ 1.0 の値である必要があります。

メソッドが成功した場合は、S_OK を返します。失敗した場合、次の表に示す値が含まれますが、これに限定されません。

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

リターンコード

説明

ISpatialAudioObjectRenderStreamBase::BeginUpdatingAudioObjects は 、SetVolume の呼び出し前に呼び出されませんでした。

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

SetVolume が呼び出されない場合は、既定値の 1.0 が使用されます。 SetVolume が呼び出されると、SetVolume の別の呼び出しでボリュームが変更されるまで、設定されたボリュームがオーディオオブジェクトに使用されます。


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