IXAPOParameters::GetParameters メソッド
エフェクト固有のパラメーターの現在の値を取得します。
構文
virtual void GetParameters( void *pParameters, UINT32 ParameterByteSize) = 0
パラメーター
- pParameters
[in, out] エフェクト固有のパラメーター ブロックを受け取ります。 - ParameterByteSize
[in] pParameters のサイズ (バイト単位) です。
戻り値
なし。
解説
pParameters のデータは、完全にエフェクト固有で、IXAPOParameters::GetParameters 関数の実装により指定されます。pParameters で返されるデータを使用して、XAPO の現在の状態に関する情報を提供できます。
SetParameters とは異なり、XAudio2 は、リアルタイム オーディオ処理スレッドでこのメソッドを呼び出すことはありません。このため、XAPO では、適切な同期化を使用して、IXAPOParameters::SetParameters または IXAPO::Process と共有している変数を保護する必要があります。CXAPOParametersBase クラスは、ユーザーに対してこの同期化を効率的に処理する、GetParameters のラッパーです。
XAudio2 は、このメソッドを IXAudio2Voice::GetEffectParameters メソッドから呼び出します。
このメソッドはブロックできます。CXAPOParametersBase::BeginProcess から現在のパラメーターを取得する代わりに、リアルタイム オーディオ処理スレッドから呼び出されてはなりません。
要件
ヘッダー: XAPO.h で宣言されています。