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 时释放它。 使用 IXAudio2::CreateSourceVoice 或 IXAudio2Voice::SetEffectChain 将 XAPO 传递给 XAudio2。
注意 此函数的 DirectX SDK 版本没有 pInitData 或 InitDataByteSize 参数,因为它仅采用前 2 个参数。 若要设置使用此函数的 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 |