IXAudio2Voice::SetEffectChain メソッド
ボイスのエフェクト チェーンを置き換えます。
構文
HRESULT SetEffectChain( const XAUDIO2_EFFECT_CHAIN *pEffectChain)
パラメーター
pEffectChain
[in, optional] 新しく使用されるエフェクト チェーンを表す XAUDIO2_EFFECT_CHAIN 構造体へのポインターです。NULL が渡された場合、現在のエフェクト チェーンは削除されます。注意
pEffectChain が NULL 以外の場合、ポインターが指す XAUDIO2_EFFECT_CHAIN 構造体は、少なくとも 1 つのエフェクトを指定していなければなりません。
戻り値
正常に実行された場合は S_OK を返し、失敗した場合はエラー コードを返します。XAudio2 固有のエラー コードの説明については、「XAudio2 エラー コード」を参照してください。
解説
新しいエフェクト チェーンには、古いエフェクト チェーンと同じだけの数の入力チャンネルと出力チャンネルがなければなりません。エフェクト チェーンの作成中に一部でエラーが発生した場合は、どの部分も適用されません。
エフェクトは、XAudio2 ボイスに関連付けられると、XAudio2 によって制御され、クライアントはそれ以上このエフェクトに呼び出しを行うべきではありません。これを確実に行う最も簡単な方法は、エフェクトへのすべてのポインターを解放することです。
コールバック内からの SetEffectChain の呼び出しは無効です。コールバック内から SetEffectChain を呼び出すと、XAUDIO2_E_INVALID_CALL が返されます。
要件
ヘッダー: xaudio2.h で宣言されています。