IXAudio2Voice::D isableEffect メソッド (xaudio2.h)
音声のエフェクト チェーン内の特定の位置での効果を無効にします。
構文
\\HRESULT DisableEffect(
[in] UINT32 EffectIndex,
[in] UINT32 OperationSet
);
パラメーター
[in] EffectIndex
音声のエフェクト チェーン内の効果の 0 から始まるインデックス。
[in] OperationSet
この呼び出しを遅延バッチの一部として識別します。 詳細については、「 XAudio2 操作セット の概要」を参照してください。
戻り値
成功した場合はS_OKを返します。それ以外の場合は、エラー コード。 有効なエラー コードの説明については、「 XAudio2 エラー コード」を参照してください。
注釈
特定の XAudio2 音声のエフェクト チェーンの効果は、その音声の処理サンプル レートでオーディオを消費して生成する必要があります。 変更できるオーディオ形式の唯一の側面は、チャネル数です。 たとえば、リバーブエフェクトはモノデータを5.1に変換できます。 クライアントは 、XAUDIO2_EFFECT_DESCRIPTOR 構造体の OutputChannels フィールドを使用して、各効果で生成するチャネルの数を指定できます。 エフェクト チェーン内の各効果は、次の効果で使用できるチャネルの数を生成する必要があります。 IXAudio2Voice::EnableEffect または IXAudio2Voice::D isableEffect を呼び出すと、これらの要件を満たす効果チェーンが停止します。
効果を無効にすると、処理グラフからすぐに削除されます。 エフェクトの保留中のオーディオ (リバーブ テールなど) は再生されません。 エフェクトをホストする音声の実行中は、効果を無効にしないように注意してください。 これにより、効果によってオーディオのピッチまたは音量が大幅に変更された場合に、可聴アーティファクトが発生する可能性があります。
DisableEffect は、 OperationSet が XAUDIO2_COMMIT_NOW の XAudio2 コールバックから呼び出されるとすぐに有効になります。
プラットフォームの要件
Windows 10 (XAudio2.9);Windows 8、Windows Phone 8 (XAudio 2.8);DirectX SDK (XAudio 2.7)要件
| 要件 | 値 |
|---|---|
| 対象プラットフォーム | Windows |
| ヘッダー | xaudio2.h |