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

  • [アーティクル]

音声のエフェクト チェーンを置き換えます。

構文

\\HRESULT SetEffectChain(
  [in, optional] const XAUDIO2_EFFECT_CHAIN *pEffectChain
);

パラメーター

[in, optional] pEffectChain

使用する新しいエフェクト チェーンを記述する XAUDIO2_EFFECT_CHAIN 構造体へのポインター。 NULL が渡されると、現在のエフェクト チェーンが削除されます。

メモpEffectChain が NULL 以外の場合、それが指すXAUDIO2_EFFECT_CHAIN構造体は、少なくとも 1 つの効果を指定する必要があります。
 

戻り値

成功した場合はS_OKを返します。それ以外の場合は、エラー コード。

XAudio2 固有のエラー コードの説明については、「XAudio2 エラー コード」を参照してください。

注釈

音声のエフェクト チェーンに許可されている出力チャネルの数は、音声の作成時にロックされます。 エフェクト チェーンを使用して音声を作成する場合、 SetEffectChain に渡される新しいエフェクト チェーンには、元のエフェクト チェーンと同じ数の入力チャネルと出力チャネルが必要です。 エフェクト チェーンなしで音声を作成した場合、エフェクト チェーンに許可される出力チャネルの数は、既定で音声の入力チャネル数になります。 エフェクト チェーンの作成のどの部分も失敗した場合は、適用されません。

XAudio2 音声に効果をアタッチすると、XAudio2 によって効果が制御され、クライアントはそれ以上の呼び出しを行うべきではありません。 これを確実に行う最も簡単な方法は、効果へのすべてのポインターを解放することです。

コールバック (IXAudio2EngineCallback または IXAudio2VoiceCallback) 内から SetEffectChain を呼び出すのは無効です。 コールバック内で SetEffectChain を 呼び出すと、XAUDIO2_E_INVALID_CALLが返されます。

pEffectChain 引数として渡される XAUDIO2_EFFECT_CHAIN とその中に含まれる XAUDIO2_EFFECT_DESCRIPTOR 情報は 、SetEffectChain が正常に完了した後は不要になり、 SetEffectChain が呼び出された直後に削除される可能性があります。

プラットフォームの要件

Windows 8、Windows Phone 8 (XAudio 2.8);DirectX SDK (XAudio 2.7)

要件

要件 値
対象プラットフォーム Windows
ヘッダー xaudio2.h

こちらもご覧ください

方法: エフェクト チェーンの作成

IXAudio2Voice

XAPO 概要