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

音声のエフェクト チェーン内の特定の位置で効果を有効にします。

構文

\\HRESULT EnableEffect(
  [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 を呼び出すと、これらの要件を満たす効果チェーンが停止します。

EnableEffect は、 OperationSetXAUDIO2_COMMIT_NOW の XAudio2 コールバックから呼び出すとすぐに有効になります。

プラットフォームの要件

Windows 10 (XAudio2.9);Windows 8、Windows Phone 8 (XAudio 2.8);DirectX SDK (XAudio 2.7)

要件

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

関連項目

IXAudio2Voice

XAPO 概要