API de XAudio2

Información general sobre la tecnología de las API XAudio2.

Para desarrollar API de XAudio2, necesita estos encabezados:

• hrtfapoapi.h
• x3daudio.h
• xapo.h
• xapobase.h
• xapofx.h
• xaudio2.h
• xaudio2fx.h

Para obtener instrucciones de programación para esta tecnología, consulte:

• API de XAudio2

Clase

CXAPOBase Implementación predeterminada de la interfaz IXAPO.
CXAPOParametersBase Implementación predeterminada de la interfaz IXAPOParameters.

Enumeraciones

HrtfDirectivityType Indica uno de varios patrones de directividad de stock.
HrtfDistanceDecayType Indica un tipo de descomposición basado en distancia aplicado a un sonido.
HrtfEnvironment Indica uno de varios tipos de entorno de existencias.
XAPO_BUFFER_FLAGS Describe el contenido de un búfer de secuencia.
XAUDIO2_FILTER_TYPE Indica el tipo de filtro.

Functions

AddRef Agrega una referencia al objeto XAudio2.
BeginProcess Devuelve los parámetros de proceso actuales.
CalcInputFrames Devuelve el número de fotogramas de entrada necesarios para generar el número determinado de fotogramas de salida.
CalcOutputFrames Devuelve el número de fotogramas de salida que se generarán a partir de un número determinado de fotogramas de entrada.
CommitChanges Aplica de forma atómica un conjunto de operaciones etiquetadas con un identificador determinado.
CreateFX Crea una instancia del efecto XAPOFX solicitado.
CreateHrtfApo Crea una instancia de la interfaz IXAPO para el procesamiento de la función de transferencia relacionada con el encabezado (HRTF).
CreateMasteringVoice Crea y configura una voz de maestro.
CreateSourceVoice Crea y configura una voz de origen.
CreateSubmixVoice Crea y configura una voz de submezcla.
CXAPOBase Crea una instancia de la clase CXAPOBase.
CXAPOParametersBase Crea una instancia de la clase CXAPOParametersBase.
DestroyVoice Destruye la voz. Si es necesario, detiene la voz y la quita del gráfico XAudio2.
DisableEffect Deshabilita el efecto en una posición determinada en la cadena de efectos de la voz.
Discontinuidad Notifica a una voz XAudio2 que no vienen más búferes después del último que se encuentra actualmente en su cola.
EnableEffect Habilita el efecto en una posición determinada en la cadena de efectos de la voz.
EndProcess Notifica a CXAPOParametersBase que el XAPO ha terminado de acceder a los parámetros de proceso actuales.
ExitLoop Detiene el bucle de la voz cuando llega al final de la región del bucle actual.
FlushSourceBuffers Quita todos los búferes de audio pendientes de la cola de voz.
GetChannelMask Devuelve la máscara de canal para esta voz.
GetChannelVolumes Devuelve los niveles de volumen de la voz, por canal.
GetEffectParameters Devuelve los parámetros actuales específicos del efecto de un efecto determinado en la cadena de efectos de la voz.
GetEffectState Devuelve el estado de ejecución del efecto en una posición especificada en la cadena de efectos de la voz.
GetFilterParameters Obtiene los parámetros de filtro de voz.
GetFrequencyRatio Devuelve la relación de ajuste de frecuencia de la voz.
GetOutputFilterParameters Devuelve los parámetros de filtro de uno de los envíos de voz.
GetOutputMatrix Obtiene el nivel de volumen de cada canal de la salida final de la voz. Estos canales se asignan a los canales de entrada de una voz de destino especificada.
GetParameters Obtiene los valores actuales de los parámetros específicos del efecto.
GetPerformanceData Devuelve los detalles de uso de recursos actuales, como la memoria disponible o el uso de CPU.
GetRegistrationProperties Devuelve las propiedades de registro de un XAPO.
GetRegistrationPropertiesInternal Devuelve un puntero a la estructura XAPO_REGISTRATION_PROPERTIES que contiene las propiedades de registro con las que se creó el XAPO.
GetState Devuelve los datos de posición actual del cursor de la voz.
GetVoiceDetails Devuelve información sobre las marcas de creación, los canales de entrada y la frecuencia de muestreo de una voz.
GetVolume Obtiene el nivel de volumen total actual de la voz.
Inicialización Realiza cualquier inicialización específica del efecto.
IsInputFormatSupported Consulta si se admite un formato de entrada específico para un formato de salida determinado.
IsLocked Consulta si el XAPO está bloqueado.
IsOutputFormatSupported Consulta si se admite un formato de salida específico para un formato de entrada determinado.
LockForProcess XAudio2 llama a para bloquear las configuraciones de entrada y salida de un XAPO, lo que le permite realizar cualquier inicialización final antes de que se llame a Process en el subproceso en tiempo real.
OnBufferEnd Se llama cuando la voz termina de procesar un búfer.
OnBufferStart Se llama cuando la voz está a punto de empezar a procesar un nuevo búfer de audio.
OnCriticalError Se llama si se produce un error crítico del sistema que requiere que XAudio2 se cierre y reinicie.
OnLoopEnd Se llama cuando la voz alcanza la posición final de un bucle.
OnProcessingPassEnd Lo llama XAudio2 justo después de que finalice un paso de procesamiento de audio.
OnProcessingPassStart Lo llama XAudio2 justo antes de que comience un paso de procesamiento de audio.
OnSetParameters Lo llama IXAPOParameters::SetParameters para permitir la validación de parámetros definida por el usuario.
OnStreamEnd Se llama cuando la voz acaba de terminar de reproducir una secuencia de audio contigua.
OnVoiceError Se llama cuando se produce un error crítico durante el procesamiento de voz.
OnVoiceProcessingPassEnd Se llama justo después de que finalice el procesamiento para la voz.
OnVoiceProcessingPassStart Se llama durante cada paso de procesamiento para cada voz, justo antes de que XAudio2 lea los datos de la cola del búfer de voz.
ParametersChanged Indica si se ha llamado a IXAPOParameters::SetParameters desde el último paso de procesamiento.
Process Ejecuta el código de procesamiento de señal digital (DSP) de XAPO en los búferes de entrada y salida especificados.
ProcessThru Lo llama una implementación de IXAPO::P rocess cuando se deshabilita un XAPO para el procesamiento.
QueryInterface Consulta una interfaz COM determinada en el objeto XAudio2.
RegisterForCallbacks Agrega un puntero IXAudio2EngineCallback a la lista de devoluciones de llamada del motor XAudio2.
Versión Libera una referencia al objeto XAudio2.
Reset Restablece las variables dependientes del historial de fotogramas.
ReverbConvertI3DL2ToNative Función insertada que convierte los parámetros I3DL2 (Interactive 3D Audio Rendering Guidelines Level 2.0) en parámetros XAudio2 nativos.
SetChannelVolumes Establece los niveles de volumen de la voz, por canal.
SetDebugConfiguration Cambia las opciones de registro de depuración global para XAudio2.
SetEffectChain Reemplaza la cadena de efectos de la voz.
SetEffectParameters Establece parámetros para un efecto determinado en la cadena de efectos de la voz.
SetEnvironment Selecciona el entorno acústico que se va a simular.
SetFilterParameters Establece los parámetros de filtro de la voz.
SetFrequencyRatio Establece la relación de ajuste de frecuencia de la voz.
SetOutputFilterParameters Establece los parámetros de filtro en uno de los envíos de esta voz.
SetOutputMatrix Establece el nivel de volumen de cada canal de la salida final de la voz. Estos canales se asignan a los canales de entrada de una voz de destino especificada.
SetOutputVoices Designa un nuevo conjunto de voces de submezcla o maestro para recibir la salida de la voz.
SetParameters Establece parámetros específicos del efecto.
SetSourceGain Establece el valor de ganancia de la ruta de acceso directa personalizada para la posición de origen actual. Válido solo para los sonidos reproducidos con el tipo de decaimiento personalizado HrtfDistanceDecayType.
SetSourceOrientation Establezca la matriz de rotación para la orientación de origen, con respecto al sistema de coordenadas del agente de escucha.
SetSourcePosition Establece la posición del sonido en relación con el agente de escucha.
SetSourceSampleRate Vuelve a configurar la voz para consumir datos de origen con una frecuencia de muestreo diferente a la especificada cuando se creó la voz.
Setvolume Establece el nivel de volumen general de la voz.
Iniciar Inicia el consumo y el procesamiento de audio por voz. Entrega el resultado a cualquier submezcla conectada o voces de maestro, o al dispositivo de salida.
StartEngine Inicia el subproceso de procesamiento de audio.
Detención Detiene el consumo de audio por la voz actual.
StopEngine Detiene el subproceso de procesamiento de audio.
SubmitSourceBuffer Agrega un nuevo búfer de audio a la cola de voz.
UnlockForProcess Desasigna las variables asignadas con el método LockForProcess.
Anular el registroForCallbacks Quita un puntero IXAudio2EngineCallback de la lista de devoluciones de llamada del motor XAudio2.
ValidateFormatDefault Comprueba que un formato de audio se encuentra dentro de los intervalos predeterminados admitidos.
ValidateFormatPair Comprueba que la configuración del par de formato de entrada y salida es compatible con XAPO.
X3DAudioCalculate Calcula la configuración de DSP con respecto a los parámetros 3D.
X3DAudioInitialize Establece todas las constantes de audio 3D globales.
XAPOAlloc Macro de asignación de memoria usada por métodos IXAPO que deben asignar estructuras de tamaño arbitrario que posteriormente se devuelven a la aplicación.
XAPOFree Macro que se usa para liberar memoria asignada con la macro XAPOAlloc.
XAudio2AmplitudeRatioToDecibels Función insertada que convierte un valor de relación de amplitud en un valor de decibel.
XAudio2Create Crea un nuevo objeto XAudio2 y devuelve un puntero a su interfaz IXAudio2.
XAudio2CreateReverb Crea un nuevo objeto de procesamiento de audio reverberación (APO) y devuelve un puntero a él.
XAudio2CreateVolumeMeter Crea un nuevo objeto de procesamiento de audio de medidor de volumen (APO) y devuelve un puntero a él.
XAudio2CutoffFrequencyToOnePoleCoefficient Función insertada que convierte de frecuencias de corte de filtro expresadas en hercios a los coeficientes de filtro utilizados con el miembro Frequency de la estructura XAUDIO2_FILTER_PARAMETERS.
XAudio2CutoffFrequencyToRadians Función insertada que convierte de frecuencias de corte de filtro expresadas en hercios a los valores de frecuencia radian utilizados en el miembro Frequency de la estructura XAUDIO2_FILTER_PARAMETERS.
XAudio2DecibelsToAmplitudeRatio Función insertada que convierte un valor de decibel en un valor de relación de amplitud.
XAudio2FrequencyRatioToSemitones Función insertada que convierte un valor de relación de frecuencia en un valor de semitono.
XAudio2RadiansToCutoffFrequency Función insertada que convierte de las frecuencias radianes usadas en XAUDIO2_FILTER_PARAMETERS de vuelta a frecuencias absolutas en hercios.
XAudio2SemitonesToFrequencyRatio Función insertada que convierte un valor de semitono en un valor de relación de frecuencia.

Interfaces

IXAPO Interfaz de un objeto de procesamiento de audio que se usa en una cadena de efectos XAudio2.
IXAPOHrtfParameters Interfaz que se usa para establecer parámetros que controlan cómo se aplica la función de transferencia relacionada con el encabezado (HRTF) a un sonido.
IXAPOParameters Interfaz opcional que permite a un XAPO usar parámetros específicos del efecto.
IXAudio2 IXAudio2 es la interfaz del objeto XAudio2 que administra todos los estados del motor de audio, el subproceso de procesamiento de audio, el gráfico de voz, etc.
IXAudio2EngineCallback La interfaz IXAudio2EngineCallback contiene métodos que notifican al cliente cuándo se producen determinados eventos en el motor IXAudio2.
IXAudio2MasteringVoice Se usa una voz de maestro para representar el dispositivo de salida de audio.
IXAudio2SourceVoice Use una voz de origen para enviar datos de audio a la canalización de procesamiento de XAudio2.
IXAudio2SubmixVoice Una voz de submezcla se usa principalmente para mejoras de rendimiento y procesamiento de efectos.
IXAudio2Voice IXAudio2Voice representa la interfaz base de la que se derivan IXAudio2SourceVoice, IXAudio2SubmixVoice y IXAudio2MasteringVoice. Los métodos que se enumeran a continuación son comunes a todas las subclases de voz.
IXAudio2VoiceCallback La interfaz IXAudio2VoiceCallback contiene métodos que notifican al cliente cuándo se producen determinados eventos en un objeto IXAudio2SourceVoice determinado.

Estructuras

FXECHO_INITDATA Parámetros de inicialización para su uso con FXECHO XAPOFX.
FXECHO_PARAMETERS Parámetros para su uso con FXECHO XAPOFX.
FXEQ_PARAMETERS Parámetros para su uso con FXEQ XAPO.
FXMASTERINGLIMITER_PARAMETERS Parámetros para su uso con FXMasteringLimiter XAPO.
FXREVERB_PARAMETERS Parámetros para su uso con FXReverb XAPO.
HrtfApoInit Especifica los parámetros usados para inicializar el audio espacial HRTF.
HrtfDirectivity Descriptor de patrón de directividad base. Describe el tipo de directividad aplicada a un sonido.
HrtfDirectivityCardioid Describe un patrón de directividad cardioide.
HrtfDirectivityCone Describe una directividad cone.
HrtfDistanceDecay Describe un comportamiento de descomposición basado en la distancia.
HrtfOrientation Indica la orientación de un objeto de directividad HRTF.
HrtfPosition Representa una posición en el espacio 3D, utilizando un sistema de coordenadas a la derecha.
X3DAUDIO_CONE Especifica la direccionalidad de un emisor no LFE de un solo canal mediante el escalado del comportamiento de DSP con respecto a la orientación del emisor.
X3DAUDIO_DISTANCE_CURVE Define una curva explícita por partes formada por segmentos lineales, definiendo directamente el comportamiento de DSP con respecto a la distancia normalizada.
X3DAUDIO_DISTANCE_CURVE_POINT Define una configuración de DSP a una distancia normalizada determinada.
X3DAUDIO_DSP_SETTINGS Recibe los resultados de una llamada a X3DAudioCalculate.
X3DAUDIO_EMITTER Define una fuente de audio 3D de punto único o de varios puntos que se usa con un número arbitrario de canales de sonido.
X3DAUDIO_LISTENER Define un punto de recepción de audio 3D.
XAPO_LOCKFORPROCESS_PARAMETERS Define los parámetros del búfer de secuencia que permanecen constantes mientras un XAPO está bloqueado. Se usa con el método IXAPO::LockForProcess.
XAPO_PROCESS_BUFFER_PARAMETERS Define los parámetros del búfer de secuencia que pueden cambiar de una llamada a la siguiente. Se usa con el método Process.
XAPO_REGISTRATION_PROPERTIES Describe las características generales de un XAPO. Se usa con IXAPO::GetRegistrationProperties, CXAPOParametersBase::CXAPOParametersBase y CXAPOBase::CXAPOBase.
XAUDIO2_BUFFER Representa un búfer de datos de audio, que se usa con IXAudio2SourceVoice::SubmitSourceBuffer.
XAUDIO2_BUFFER_WMA Se usa con IXAudio2SourceVoice::SubmitSourceBuffer al enviar datos xWMA.
XAUDIO2_DEBUG_CONFIGURATION Contiene la nueva configuración de depuración global para XAudio2. Se usa con la función SetDebugConfiguration.
XAUDIO2_EFFECT_CHAIN Define una cadena de efectos.
XAUDIO2_EFFECT_DESCRIPTOR Contiene información sobre un XAPO para su uso en una cadena de efectos.
XAUDIO2_FILTER_PARAMETERS Define parámetros de filtro para una voz de origen.
XAUDIO2_PERFORMANCE_DATA Contiene información de rendimiento. (XAUDIO2_PERFORMANCE_DATA)
XAUDIO2_SEND_DESCRIPTOR Define una voz de destino que es el destino de un envío desde otra voz y especifica si se debe usar un filtro.
XAUDIO2_VOICE_DETAILS Contiene información sobre las marcas de creación, los canales de entrada y la frecuencia de muestreo de una voz.
XAUDIO2_VOICE_SENDS Define un conjunto de voces para recibir datos de una sola voz de salida.
XAUDIO2_VOICE_STATE Devuelve el estado actual de la voz y los datos de posición del cursor.
XAUDIO2FX_REVERB_I3DL2_PARAMETERS Describe los parámetros I3DL2 (Interactive 3D Audio Rendering Guidelines Level 2.0) para su uso en la función ReverbConvertI3DL2ToNative.
XAUDIO2FX_REVERB_PARAMETERS Describe los parámetros para su uso en el APO de reverberación.
XAUDIO2FX_VOLUMEMETER_LEVELS Describe los parámetros para su uso con el APO de medidor de volumen.