Функция CreateFX (xapofx.h)

Статья
08/28/2023

Создает экземпляр запрошенного эффекта XAPOFX .

Синтаксис

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

Параметры

clsid

Идентификатор создаваемого эффекта. Используйте __uuidof имени класса эффекта, чтобы получить идентификатор CLSID для эффекта. Например, __uuidof(FXReverb) будет предоставлять CLSID для эффекта FXReverb. Список эффектов, предоставляемых XAPOFX, см. в разделе Обзор XAPOFX. Пример получения CLSID для эффекта см. в разделе Практическое руководство. Использование XAPOFX в XAudio2.

pEffect

Получает указатель на созданный экземпляр XAPO. Если CreateFX завершается сбоем, pEffect не будет тронут.

DEFAULT

Возвращаемое значение

Если эта функция выполняется успешно, она возвращает S_OK. В противном случае возвращается код ошибки HRESULT .

Число ссылок созданного объекта XAPO будет иметь значение 1. Клиентский код должен вызывать IUnknown::Release после передачи XAPO в XAudio2, чтобы разрешить XAudio2 удалять XAPO, когда он больше не нужен. Используйте IXAudio2::CreateSourceVoice или IXAudio2Voice::SetEffectChain , чтобы передать XAPO в XAudio2.

Примечание Версия пакета SDK для DirectX этой функции не имеет параметров pInitData или InitDataByteSize , так как принимает только первые 2 параметра. Чтобы задать начальные параметры для эффекта XAPOFX , созданного с помощью версии пакета SDK для DirectX этой функции, необходимо привязать этот эффект к голосу и использовать IXAudio2Voice::SetEffectParameters. Дополнительные сведения о том, как это сделать, см. в разделе Практическое руководство. Использование XAPOFX в XAudio2.

Требования к платформе

Windows 10 (XAudio2.9); Windows 8, Windows Phone 8 (XAudio 2.8); Пакет SDK Для DirectX (XAudio 2.7)

Требования

Требование	Значение
Целевая платформа	Windows
Header	xapofx.h
Библиотека	XAudio.lib
DLL	Windows.Media.Audio.dll

См. также

Функции