IXAudio2Voice::GetEffectParameters メソッド
ボイスのエフェクト チェーンにおける、特定のエフェクトの現在のエフェクト固有パラメーターを返します。
構文
HRESULT GetEffectParameters( UINT32 EffectIndex, void *pParameters, UINT32 ParametersByteSize)
パラメーター
- EffectIndex
[in] ボイスのエフェクト チェーン内のエフェクトの、0 から始まるインデックス。 - pParameters
[out] エフェクト固有のパラメーターの現在の値を返します。 - ParametersByteSize
[out] pParameters 配列のサイズ (バイト単位) です。
戻り値
正常に実行された場合は S_OK を返し、失敗した場合はエラー コードを返します。エラー コードの説明については、「XAudio2 エラー コード」を参照してください。
エフェクトで汎用パラメーター制御インターフェイスがサポートされていない場合は、失敗して E_NOTIMPL が返されます。
解説
GetEffectParameters は、常にエフェクトの現在の実際のパラメーターを返します。ただし、これらのパラメーターは、前回の IXAudio2Voice::SetEffectParameters 呼び出しによって設定されたパラメーターと一致しない場合があります。実際のパラメーターは、IXAudio2Voice::SetEffectParameters 呼び出しの後 (または、IXAudio2Voice::SetEffectParameters が遅延操作 ID を使用して呼び出された場合は、対応する IXAudio2::CommitChanges 呼び出しの後)、次にオーディオ エンジンが実行されたときに初めて変更されます。
要件
ヘッダー: xaudio2.h で宣言されています。