ISpatialAudioObjectForHrtf::SetGain メソッド (spatialaudiohrtf.h)
dB の ISpatialAudioObjectForHrtf のゲインを設定します。
構文
HRESULT SetGain(
[in] float gain
);
パラメーター
[in] gain
dB の ISpatialAudioObjectForHrtf のゲイン。
戻り値
メソッドが成功した場合は、S_OK を返します。 エラーが発生した場合、次の表に示す値が、可能なリターン コードに含まれますが、これらに限定されません。
| リターン コード | 説明 |
|---|---|
|
ISpatialAudioObjectRenderStreamBase::BeginUpdatingAudioObjects は 、SetGain の呼び出しの前に呼び出されませんでした。 |
|
SetEndOfStream は、以前のオーディオ処理パスで明示的または暗黙的に呼び出されました。 GetBuffer がオーディオ処理パス内で呼び出されない場合 (ISpatialAudioObjectRenderStreamBase::BeginUpdatingAudioObjects と ISpatialAudioObjectRenderStreamBase::EndUpdatingAudioObjects の呼び出しの間)、SetEndOfStream はシステムによって暗黙的に呼び出されます。 |
注釈
これは、 SpatialAudioHrtfDistanceDecay_CustomDecay 減衰タイプを使用するように構成された空間オーディオ オブジェクトに対してのみ有効です。 SetDistanceDecay を呼び出して、ISpatialAudioObjectForHrtf オブジェクトの減衰型を設定します。 ISpatialAudioClient::ActivateSpatialAudioStream に渡される SpatialAudioHrtfActivationParams の DistanceDecay フィールドを設定して、HRTF レンダー ストリーム内のすべてのオブジェクトの既定の減衰の種類を設定します。
SetGain が呼び出されない場合は、既定値の 0.0 が使用されます。 SetGain が呼び出されると、SetGain の別の呼び出しでゲインが変更されるまで、設定されたゲインがオーディオ オブジェクトに使用されます。
要件
| 要件 | 値 |
|---|---|
| 対象プラットフォーム | Windows |
| ヘッダー | spatialaudiohrtf.h |