Compartilhar via


Função CreateFX (xapofx.h)

Cria uma instância do efeito XAPOFX solicitado.

Sintaxe

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

Parâmetros

clsid

ID do efeito a ser criado. Use o __uuidof no nome da classe de efeito para obter o CLSID para um efeito. Por exemplo, __uuidof(FXReverb) forneceria o CLSID para o efeito FXReverb. Para obter uma lista dos efeitos fornecidos pelo XAPOFX, consulte Visão geral do XAPOFX. Para obter um exemplo de recuperação do CLSID para um efeito, consulte Como usar XAPOFX no XAudio2.

pEffect

Recebe um ponteiro para a instância XAPO criada. Se CreateFX falhar, pEffect não será alterado.

DEFAULT

DEFAULT

Retornar valor

Se essa função for bem-sucedida, ela retornará S_OK. Caso contrário, ele retornará um código de erro HRESULT.

Comentários

O XAPO criado terá uma contagem de referência de 1. O código do cliente deve chamar IUnknown::Release depois de passar o XAPO para XAudio2 para permitir que XAudio2 descarte o XAPO quando ele não for mais necessário. Use IXAudio2::CreateSourceVoice ou IXAudio2Voice::SetEffectChain para passar um XAPO para XAudio2.

Nota A versão do SDK do DirectX dessa função não tem os parâmetros pInitData ou InitDataByteSize , pois ela usa apenas os dois primeiros parâmetros. Para definir parâmetros iniciais para o efeito XAPOFX criado com a versão do SDK do DirectX dessa função, você deve associar esse efeito a uma voz e usar IXAudio2Voice::SetEffectParameters. Para obter informações sobre como fazer isso, consulte Como usar XAPOFX no XAudio2.
 

Requisitos de plataforma

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

Requisitos

Requisito Valor
Plataforma de Destino Windows
Cabeçalho xapofx.h
Biblioteca XAudio.lib
DLL Windows.Media.Audio.dll

Confira também

Funções