CreateFX-Funktion (xapofx.h)

  • Artikel

Erstellt eine instance des angeforderten XAPOFX-Effekts.

Syntax

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

Parameter

clsid

ID des zu erstellenden Effekts. Verwenden Sie die __uuidof für den Namen der Effektklasse, um die CLSID für einen Effekt abzurufen. Beispielsweise würde __uuidof(FXReverb) die CLSID für den EFFEKT FXReverb bereitstellen. Eine Liste der von XAPOFX bereitgestellten Effekte finden Sie unter Übersicht über XAPOFX. Ein Beispiel zum Abrufen der CLSID für einen Effekt finden Sie unter Vorgehensweise: Verwenden von XAPOFX in XAudio2.

pEffect

Empfängt einen Zeiger auf die erstellte XAPO-instance. Wenn CreateFX fehlschlägt, ist pEffect unverändert.

DEFAULT

DEFAULT

Rückgabewert

Wenn diese Funktion erfolgreich ist, gibt sie S_OK zurück. Andernfalls wird ein Fehlercode HRESULT zurückgegeben.

Hinweise

Das erstellte XAPO weist eine Referenzanzahl von 1 auf. Der Clientcode muss IUnknown::Release aufrufen, nachdem das XAPO an XAudio2 übergeben wurde, damit XAudio2 das XAPO entsorgen kann, wenn es nicht mehr benötigt wird. Verwenden Sie IXAudio2::CreateSourceVoice oder IXAudio2Voice::SetEffectChain , um ein XAPO an XAudio2 zu übergeben.

Hinweis Die DirectX SDK-Version dieser Funktion verfügt nicht über die Parameter pInitData oder InitDataByteSize , da sie nur die ersten 2 Parameter benötigt. Um erste Parameter für den XAPOFX-Effekt festzulegen, der mit der DirectX SDK-Version dieser Funktion erstellt wird, müssen Sie diesen Effekt an eine Stimme binden und IXAudio2Voice::SetEffectParameters verwenden. Informationen dazu finden Sie unter Vorgehensweise: Verwenden von XAPOFX in XAudio2.
 

Plattformanforderungen

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

Anforderungen

Anforderung Wert
Zielplattform Windows
Kopfzeile xapofx.h
Bibliothek XAudio.lib
DLL Windows.Media.Audio.dll

Siehe auch

Funktionen