CreateFX, fonction (xapofx.h)

Article
03/13/2024

Crée une instance de l’effet XAPOFX demandé.

Syntaxe

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

Paramètres

clsid

ID de l’effet à créer. Utilisez le __uuidof sur le nom de la classe d’effet pour obtenir le CLSID d’un effet. Par exemple, __uuidof(FXReverb) fournit le CLSID pour l’effet FXReverb. Pour obtenir la liste des effets fournis par XAPOFX, consultez Vue d’ensemble de XAPOFX. Pour obtenir un exemple de récupération du CLSID pour un effet, consultez Guide pratique pour utiliser XAPOFX dans XAudio2.

pEffect

Reçoit un pointeur vers le instance XAPO créé. Si CreateFX échoue, pEffect n’est pas modifié.

DEFAULT

Valeur retournée

Si cette fonction réussit, elle retourne S_OK. Sinon, elle retourne un code d’erreur HRESULT.

Remarques

Le XAPO créé aura un nombre de références de 1. Le code client doit appeler IUnknown ::Release après avoir passé le XAPO à XAudio2 pour permettre à XAudio2 de supprimer le XAPO lorsqu’il n’est plus nécessaire. Utilisez IXAudio2 ::CreateSourceVoice ou IXAudio2Voice ::SetEffectChain pour passer un XAPO à XAudio2.

Note La version du Kit de développement logiciel (SDK) DirectX de cette fonction n’a pas les paramètres pInitData ou InitDataByteSize , car elle ne prend que les 2 premiers paramètres. Pour définir les paramètres initiaux de l’effet XAPOFX créé avec la version du SDK DirectX de cette fonction, vous devez lier cet effet à une voix et utiliser IXAudio2Voice ::SetEffectParameters. Pour plus d’informations sur la procédure à suivre, consultez Guide pratique pour utiliser XAPOFX dans XAudio2.

Configuration requise pour la plateforme

Windows 10 (XAudio2.9) ; Windows 8, Windows Phone 8 (XAudio 2.8) ; Kit de développement logiciel (SDK) DirectX (XAudio 2.7)

Configuration requise

Condition requise	Valeur
Plateforme cible	Windows
En-tête	xapofx.h
Bibliothèque	XAudio.lib
DLL	Windows.Media.Audio.dll

Voir aussi

Fonctions

Partager via