CreateFX 関数 (xapofx.h)

  • [アーティクル]

要求された XAPOFX 効果のインスタンスを作成します。

構文

FX_API_(HRESULT) CreateFX(
             REFCLSID                clsid,
             IUnknown                **pEffect,
             const void *pInitDat    DEFAULT,
             UINT32 InitDataByteSize DEFAULT
);

パラメーター

clsid

作成する効果の ID。 効果クラス名の __uuidof を使用して、効果の CLSID を取得します。 たとえば、 __uuidof(FXReverb) は FXReverb 効果の CLSID を提供します。 XAPOFX によって提供される効果の一覧については、「 XAPOFX の概要」を参照してください。 効果の CLSID を取得する例については、「 方法: XAudio2 で XAPOFX を使用する」を参照してください。

pEffect

作成された XAPO インスタンスへのポインターを受け取ります。 CreateFX が失敗した場合、pEffect は変更されません。

DEFAULT

DEFAULT

戻り値

この関数が成功すると、 S_OKが返されます。 そうでない場合は、HRESULT エラー コードを返します。

注釈

作成された XAPO の参照カウントは 1 になります。 クライアント コードでは、XAPO を XAudio2 に渡した後に IUnknown::Release を呼び出して、XAudio2 が不要になったときに XAPO を破棄できるようにする必要があります。 XAudio2 に XAPO を渡すには、 IXAudio2::CreateSourceVoice または IXAudio2Voice::SetEffectChain を使用します。

メモ この関数の DirectX SDK バージョンには、最初の 2 つのパラメーターのみを受け取る pInitData または InitDataByteSize パラメーターがありません。 この関数の DirectX SDK バージョンで作成される XAPOFX 効果の初期パラメーターを設定するには、その効果を音声にバインドし、 IXAudio2Voice::SetEffectParameters を使用する必要があります。 これを行う方法については、「 方法: XAudio2 で XAPOFX を使用する」を参照してください。
 

プラットフォームの要件

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

要件

要件 値
対象プラットフォーム Windows
ヘッダー xapofx.h
Library XAudio.lib
[DLL] Windows.Media.Audio.dll

関連項目

関数