Método IXAudio2Voice::SetEffectChain (xaudio2.h)

Reemplaza la cadena de efectos de la voz.

Sintaxis

\\HRESULT SetEffectChain(
  [in, optional] const XAUDIO2_EFFECT_CHAIN *pEffectChain
);

Parámetros

[in, optional] pEffectChain

Puntero a una estructura XAUDIO2_EFFECT_CHAIN que describe la nueva cadena de efectos que se va a usar. Si se pasa NULL, se quita la cadena de efectos actual.

Nota Si pEffectChain no es NULL, la estructura XAUDIO2_EFFECT_CHAIN a la que apunta debe especificar al menos un efecto.

 

Valor devuelto

Devuelve S_OK si se ejecuta correctamente; de lo contrario, un código de error.

Consulte Códigos de error XAudio2 para obtener descripciones de códigos de error específicos de XAudio2.

Comentarios

El número de canales de salida permitidos para la cadena de efectos de una voz se bloquea al crear la voz. Si crea la voz con una cadena de efectos, cualquier nueva cadena de efectos pasada a SetEffectChain debe tener el mismo número de canales de entrada y salida que la cadena de efectos original. Si crea la voz sin una cadena de efectos, el número de canales de salida permitidos para la cadena de efectos tendrá como valor predeterminado el número de canales de entrada para la voz. Si se produce un error en cualquier parte de la creación de la cadena de efectos, no se aplica ninguno.

Después de adjuntar un efecto a una voz XAudio2, XAudio2 toma el control del efecto y el cliente no debe realizar más llamadas a él. La manera más sencilla de asegurarse de esto es liberar todos los punteros al efecto.

No es válido llamar a SetEffectChain desde una devolución de llamada (es decir, IXAudio2EngineCallback o IXAudio2VoiceCallback). Si llama a SetEffectChain dentro de una devolución de llamada, devuelve XAUDIO2_E_INVALID_CALL.

El XAUDIO2_EFFECT_CHAIN que se pasa como el argumento pEffectChain y cualquier información de XAUDIO2_EFFECT_DESCRIPTOR contenida en ella ya no es necesaria después de que SetEffectChain se complete correctamente y se pueda eliminar inmediatamente después de llamar a SetEffectChain .

Requisitos de la plataforma

Windows 8, Windows Phone 8 (XAudio 2.8); SDK de DirectX (XAudio 2.7)

Requisitos

Requisito	Value
Plataforma de destino	Windows
Encabezado	xaudio2.h

Consulte también

Cómo: crear un efecto en cadena

IXAudio2Voice

Introducción a XAPO