IXAudio2Voice::GetEffectParameters メソッド (xaudio2.h)

音声のエフェクト チェーン内の特定のエフェクトの現在のエフェクト固有のパラメーターを返します。

構文

\\HRESULT GetEffectParameters(
  [in]  UINT32 EffectIndex,
  [out] void   *pParameters,
  [out] UINT32 ParametersByteSize
);

パラメーター

[in] EffectIndex

音声の効果チェーン内の効果の 0 から始まるインデックス。

[out] pParameters

効果固有のパラメーターの現在の値を返します。

[out] ParametersByteSize

pParameters 配列のサイズ (バイト単位)。

戻り値

成功した場合はS_OKを返し、それ以外の場合はエラー コードを返します。 エラー コードの説明については、「 XAudio2 エラー コード 」を参照してください。

効果がジェネリック パラメーター制御インターフェイスをサポートしていない場合、E_NOTIMPLで失敗します。

解説

GetEffectParameters は 、常に効果の実際の現在のパラメーターを返します。 ただし、IXAudio2Voice::SetEffectParameters の最新の呼び出しによって設定されたパラメーターと一致しない場合があります。実際のパラメーターは、IXAudio2Voice::SetEffectParameters 呼び出しの後 (または、IXAudio2Voice::SetEffectParameters が遅延操作 ID で呼び出された場合は、対応する IXAudio2::CommitChanges 呼び出しの後) にオーディオ エンジンが次回実行されたときにのみ変更されます。

プラットフォームの要件

要件

関連項目

IXAPOParameters::GetParameters

IXAudio2Voice

XAPO 概要