Método IXAudio2Voice::D isableEffect (xaudio2.h)

Deshabilita el efecto en una posición determinada en la cadena de efectos de la voz.

Sintaxis

\\HRESULT DisableEffect(
  [in] UINT32 EffectIndex,
  [in] UINT32 OperationSet
);

Parámetros

[in] EffectIndex

Índice de base cero de un efecto en la cadena de efectos de la voz.

[in] OperationSet

Identifica esta llamada como parte de un lote diferido. Consulte la introducción a los conjuntos de operaciones XAudio2 para obtener más información.

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 válidos.

Comentarios

Los efectos de una cadena de efectos de voz XAudio2 determinada deben consumir y producir audio a la velocidad de muestreo de procesamiento de esa voz. El único aspecto del formato de audio que pueden cambiar es el recuento de canales. Por ejemplo, un efecto de reverberación puede convertir datos mono en 5.1. El cliente puede usar el campo OutputChannels de la estructura XAUDIO2_EFFECT_DESCRIPTOR para especificar el número de canales que quiere que genere cada efecto. Cada efecto de una cadena de efectos debe producir una serie de canales que el siguiente efecto puede consumir. Cualquier llamada a IXAudio2Voice::EnableEffect o IXAudio2Voice::D isableEffect que haría que la cadena de efectos dejara de cumplir estos requisitos producirá un error.

Al deshabilitar un efecto, se quita inmediatamente del gráfico de procesamiento. No se reproduce ningún audio pendiente en el efecto, como una cola de reverberación. Tenga cuidado de deshabilitar un efecto mientras se ejecuta la voz que hospeda. Esto puede dar lugar a un artefacto audible si el efecto cambia significativamente el tono o el volumen del audio.

DisableEffect surte efecto inmediatamente cuando se llama desde una devolución de llamada XAudio2 con un OperationSet de XAUDIO2_COMMIT_NOW.

Requisitos de la plataforma

Windows 10 (XAudio2.9); 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

IXAudio2Voice

Información general sobre XAPO