API XAudio2

Panoramica della tecnologia delle API XAudio2.

Per sviluppare API XAudio2, sono necessarie queste intestazioni:

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

Per indicazioni sulla programmazione per questa tecnologia, vedere:

• API XAudio2

Classe

CXAPOBase Implementazione predefinita dell'interfaccia IXAPO.
CXAPOParametersBase Implementazione predefinita dell'interfaccia IXAPOParameters.

Enumerazioni

HrtfDirectivityType Indica uno dei diversi modelli di directivity stock.
HrtfDistanceDecayType Indica un tipo di decadimento basato sulla distanza applicato a un suono.
HrtfEnvironment Indica uno dei diversi tipi di ambiente stock.
XAPO_BUFFER_FLAGS Descrive il contenuto di un buffer di flusso.
XAUDIO2_FILTER_TYPE Indica il tipo di filtro.

Funzioni

AddRef Aggiunge un riferimento all'oggetto XAudio2.
BeginProcess Restituisce i parametri del processo corrente.
CalcInputFrames Restituisce il numero di fotogrammi di input necessari per generare il numero specificato di fotogrammi di output.
CalcOutputFrames Restituisce il numero di fotogrammi di output che verranno generati da un determinato numero di fotogrammi di input.
Commitchanges Applica in modo atomico un set di operazioni contrassegnate con un identificatore specificato.
CreateFX Crea un'istanza dell'effetto XAPOFX richiesto.
CreateHrtfApo Crea un'istanza dell'interfaccia IXAPO per l'elaborazione hrtf (head-related transfer function).
CreateMasteringVoice Crea e configura una voce mastering.
CreateSourceVoice Crea e configura una voce di origine.
CreateSubmixVoice Crea e configura una voce di submix.
CXAPOBase Crea un'istanza della classe CXAPOBase.
CXAPOParametersBase Crea un'istanza della classe CXAPOParametersBase.
DestroyVoice Distrugge la voce. Se necessario, arresta la voce e la rimuove dal grafico XAudio2.
DisableEffect Disabilita l'effetto in una determinata posizione nella catena di effetti della voce.
Discontinuità Notifica a una voce XAudio2 che non vengono più memorizzati buffer dopo l'ultimo oggetto attualmente presente nella coda.
EnableEffect Abilita l'effetto in una determinata posizione nella catena di effetti della voce.
EndProcess Notifica a CXAPOParametersBase che XAPO ha completato l'accesso ai parametri del processo corrente.
ExitLoop Arresta il ciclo della voce quando raggiunge la fine dell'area del ciclo corrente.
FlushSourceBuffers Rimuove tutti i buffer audio in sospeso dalla coda vocale.
GetChannelMask Restituisce la maschera del canale per questa voce.
GetChannelVolumes Restituisce i livelli di volume per la voce, per canale.
GetEffectParameters Restituisce i parametri correnti specifici dell'effetto di un determinato effetto nella catena di effetti della voce.
GetEffectState Restituisce lo stato di esecuzione dell'effetto in corrispondenza di una posizione specificata nella catena di effetti della voce.
GetFilterParameters Ottiene i parametri di filtro della voce.
GetFrequencyRatio Restituisce il rapporto di regolazione della frequenza della voce.
GetOutputFilterParameters Restituisce i parametri del filtro da uno degli invii di questa voce.
GetOutputMatrix Ottiene il livello di volume di ogni canale dell'output finale per la voce. Questi canali vengono mappati ai canali di input di una voce di destinazione specificata.
GetParameters Ottiene i valori correnti per tutti i parametri specifici dell'effetto.
GetPerformanceData Restituisce i dettagli di utilizzo delle risorse correnti, ad esempio la memoria disponibile o l'utilizzo della CPU.
GetRegistrationProperties Restituisce le proprietà di registrazione di un oggetto XAPO.
GetRegistrationPropertiesInternal Restituisce un puntatore alla struttura XAPO_REGISTRATION_PROPERTIES contenente le proprietà di registrazione con cui è stato creato L'espressione XAPO.
GetState Restituisce i dati sulla posizione corrente del cursore della voce.
GetVoiceDetails Restituisce informazioni sui flag di creazione, sui canali di input e sulla frequenza di campionamento di una voce.
GetVolume Ottiene il livello di volume complessivo corrente della voce.
Initialize Esegue qualsiasi inizializzazione specifica dell'effetto.
IsInputFormatSupported Query se è supportato un formato di input specifico per un determinato formato di output.
IsLocked Esegue una query sul fatto che XAPO sia bloccato.
IsOutputFormatSupported Le query se un formato di output specifico è supportato per un determinato formato di input.
LockForProcess Chiamato da XAudio2 per bloccare le configurazioni di input e output di un XAPO che consente di eseguire qualsiasi inizializzazione finale prima che il processo venga chiamato nel thread in tempo reale.
OnBufferEnd Chiamato al termine dell'elaborazione di un buffer.
OnBufferStart Chiamato quando la voce sta per avviare l'elaborazione di un nuovo buffer audio.
OnCriticalError Chiamato se si verifica un errore di sistema critico che richiede che XAudio2 venga chiuso e riavviato.
OnLoopEnd Chiamato quando la voce raggiunge la posizione finale di un ciclo.
OnProcessingPassEnd Chiamato da XAudio2 appena dopo la fine di un passaggio di elaborazione audio.
OnProcessingPassStart Chiamato da XAudio2 appena prima dell'inizio di un passaggio di elaborazione audio.
OnSetParameters Chiamato da IXAPOParameters::SetParameters per consentire la convalida dei parametri definita dall'utente.
OnStreamEnd Chiamato al termine della riproduzione di un flusso audio contiguo.
OnVoiceError Chiamato quando si verifica un errore critico durante l'elaborazione vocale.
OnVoiceProcessingPassEnd Chiamato appena dopo il passaggio di elaborazione per la fine della voce.
OnVoiceProcessingPassStart Chiamato durante ogni passaggio di elaborazione per ogni voce, appena prima di XAudio2 legge i dati dalla coda del buffer della voce.
ParametriChanged Indica se IXAPOParameters::SetParameters è stato chiamato dall'ultimo passaggio di elaborazione.
Processo Esegue il codice DSP (Digital Signal Processing) di XAPO nei buffer di input e output specificati.
ProcessThru Chiamato da un'implementazione IXAPO::P rocess quando un XAPO è disabilitato per l'elaborazione tramite.
QueryInterface Query per un'interfaccia COM specificata nell'oggetto XAudio2.
RegisterForCallbacks Aggiunge un puntatore IXAudio2EngineCallback all'elenco di callback del motore XAudio2.
Versione Rilascia un riferimento all'oggetto XAudio2.
Reimpostazione Reimposta le variabili dipendenti dalla cronologia dei frame.
ReverbConvertI3DL2ToNative Funzione inline che converte i parametri I3DL2 (Interactive 3D Audio Rendering Guidelines Level 2.0) in parametri XAudio2 nativi.
SetChannelVolumes Imposta i livelli di volume per la voce, per canale.
SetDebugConfiguration Modifica le opzioni di registrazione di debug globali per XAudio2.
SetEffectChain Sostituisce la catena di effetti della voce.
SetEffectParameters Imposta i parametri per un determinato effetto nella catena di effetti della voce.
SetEnvironment Seleziona l'ambiente acustico da simulare.
SetFilterParameters Imposta i parametri di filtro della voce.
SetFrequencyRatio Imposta il rapporto di regolazione della frequenza della voce.
SetOutputFilterParameters Imposta i parametri del filtro su uno degli invii di questa voce.
SetOutputMatrix Imposta il livello di volume di ogni canale dell'output finale per la voce. Questi canali vengono mappati ai canali di input di una voce di destinazione specificata.
SetOutputVoices Definisce un nuovo set di voci di sottomix o mastering per ricevere l'output della voce.
SetParameters Imposta parametri specifici dell'effetto.
SetSourceGain Imposta il valore di guadagno del percorso diretto personalizzato per la posizione di origine corrente. Valido solo per i suoni riprodotti con il tipo di decadimento personalizzato HrtfDistanceDecayType.
SetSourceOrientation Impostare la matrice di rotazione per l'orientamento dell'origine, rispetto al sistema di coordinate del listener.
SetSourcePosition Imposta la posizione del suono rispetto al listener.
SetSourceSampleRate Riconfigura la voce per usare i dati di origine a una frequenza di esempio diversa rispetto alla frequenza specificata al momento della creazione della voce.
SetVolume Imposta il livello di volume complessivo per la voce.
Inizia Avvia l'utilizzo e l'elaborazione dell'audio dalla voce. Restituisce il risultato a qualsiasi sottomix connesso o a voci mastering o al dispositivo di output.
StartEngine Avvia il thread di elaborazione audio.
Stop Arresta l'utilizzo dell'audio dalla voce corrente.
StopEngine Arresta il thread di elaborazione audio.
SubmitSourceBuffer Aggiunge un nuovo buffer audio alla coda vocale.
UnlockForProcess Dealloca le variabili allocate con il metodo LockForProcess.
Annullare la registrazioneForCallbacks Rimuove un puntatore IXAudio2EngineCallback dall'elenco di callback del motore XAudio2.
ValidateFormatDefault Verifica che un formato audio rientra negli intervalli predefiniti supportati.
ValidateFormatPair Verifica che la configurazione di una coppia di formati di input e di output sia supportata da XAPO.
X3DAudioCalculate Calcola le impostazioni DSP rispetto ai parametri 3D.
X3DAudioInitialize Imposta tutte le costanti audio 3D globali.
XAPOAlloc Macro di allocazione della memoria utilizzata dai metodi IXAPO che devono allocare strutture di dimensioni arbitrarie che vengono successivamente restituite all'applicazione.
XAPOFree Macro utilizzata per liberare memoria allocata con la macro XAPOAlloc.
XAudio2AmplitudeRatioToDecibels Funzione inline che converte un valore del rapporto di ampiezza in un valore decibel.
XAudio2Create Crea un nuovo oggetto XAudio2 e restituisce un puntatore all'interfaccia IXAudio2.
XAudio2CreateReverb Crea un nuovo oggetto di elaborazione audio riverbero (APO) e restituisce un puntatore.
XAudio2CreateVolumeMeter Crea un nuovo oggetto di elaborazione audio del contatore del volume (APO) e restituisce un puntatore.
XAudio2CutoffFrequencyToOnePoleCoefficient Funzione inline che converte da frequenze di cutoff di filtro espresse inhz ai coefficienti di filtro utilizzati con il membro Frequency della struttura XAUDIO2_FILTER_PARAMETERS.
XAudio2CutoffFrequencyToRadians Funzione inline che converte da frequenze di cutoff di filtro espresse inhz ai valori di frequenza radiante utilizzati nel membro Frequency della struttura XAUDIO2_FILTER_PARAMETERS.
XAudio2DecibelsToAmplitudeRatio Funzione inline che converte un valore decibel in un valore del rapporto di ampiezza.
XAudio2FrequencyRatioToSemitones Funzione inline che converte un valore del rapporto di frequenza in un valore semitone.
XAudio2RadiansToCutoffFrequency Funzione inline che converte dalle frequenze radianti usate in XAUDIO2_FILTER_PARAMETERS in frequenze assolute inhz.
XAudio2SemitonesToFrequencyRatio Funzione inline che converte un valore semitone in un valore del rapporto di frequenza.

Interfacce

IXAPO Interfaccia per un oggetto elaborazione audio che può essere utilizzata in una catena di effetti XAudio2.
IXAPOHrtfParameters Interfaccia usata per impostare i parametri che controllano la modalità di applicazione della funzione di trasferimento head (HRTF) a un suono.
IXAPOParameters Interfaccia facoltativa che consente a un oggetto XAPO di usare parametri specifici dell'effetto.
IXAudio2 IXAudio2 è l'interfaccia per l'oggetto XAudio2 che gestisce tutti gli stati del motore audio, il thread di elaborazione audio, il grafico vocale e così via.
IXAudio2EngineCallback L'interfaccia IXAudio2EngineCallback contiene metodi che notificano al client quando si verificano determinati eventi nel motore IXAudio2.
IXAudio2MasteringVoice Una voce mastering viene usata per rappresentare il dispositivo di output audio.
IXAudio2SourceVoice Usare una voce di origine per inviare dati audio alla pipeline di elaborazione XAudio2.
IXAudio2SubmixVoice Una voce di submix viene usata principalmente per migliorare le prestazioni ed eseguire l'elaborazione degli effetti.
IXAudio2Voice IXAudio2Voice rappresenta l'interfaccia di base da cui sono derivati IXAudio2SourceVoice, IXAudio2SubmixVoice e IXAudio2MasteringVoice. I metodi elencati di seguito sono comuni a tutte le sottoclassi vocali.
IXAudio2VoiceCallback L'interfaccia IXAudio2VoiceCallback contiene metodi che notificano al client quando si verificano determinati eventi in un determinato IXAudio2SourceVoice.

Strutture

FXECHO_INITDATA Parametri di inizializzazione da usare con FXECHO XAPOFX.
FXECHO_PARAMETERS Parametri da usare con FXECHO XAPOFX.
FXEQ_PARAMETERS Parametri da usare con FXEQ XAPO.
FXMASTERINGLIMITER_PARAMETERS Parametri da usare con FXMasteringLimiter XAPO.
FXREVERB_PARAMETERS Parametri da usare con FXReverb XAPO.
HrtfApoInit Specifica i parametri utilizzati per inizializzare l'audio spaziale HRTF.
HrtfDirectivity Descrittore del modello di directivity di base. Descrive il tipo di directivity applicato a un suono.
HrtfDirectivityCardioid Descrive un modello di directivity cardioid.
HrtfDirectivityCone Descrive una cone directivity.
HrtfDistanceDecay Descrive un comportamento di decadimento basato sulla distanza.
HrtfOrientation Indica l'orientamento di un oggetto directivity HRTF.
HrtfPosition Rappresenta una posizione nello spazio 3D, utilizzando un sistema di coordinate destrorso.
X3DAUDIO_CONE Specifica la direzionalità per un emettitore non LFE a canale singolo ridimensionando il comportamento DSP rispetto all'orientamento dell'emettitore.
X3DAUDIO_DISTANCE_CURVE Definisce una curva a fasi esplicita costituita da segmenti lineari, definendo direttamente il comportamento DSP rispetto alla distanza normalizzata.
X3DAUDIO_DISTANCE_CURVE_POINT Definisce un'impostazione DSP in corrispondenza di una determinata distanza normalizzata.
X3DAUDIO_DSP_SETTINGS Riceve i risultati da una chiamata a X3DAudioCalculate.
X3DAUDIO_EMITTER Definisce un'origine audio 3D a un singolo punto o a più punti usata con un numero arbitrario di canali audio.
X3DAUDIO_LISTENER Definisce un punto di ricezione audio 3D.
XAPO_LOCKFORPROCESS_PARAMETERS Definisce i parametri del buffer di flusso che rimangono costanti mentre un oggetto XAPO è bloccato. Usato con il metodo IXAPO::LockForProcess.
XAPO_PROCESS_BUFFER_PARAMETERS Definisce i parametri del buffer di flusso che possono cambiare da una chiamata alla successiva. Usato con il metodo Process.
XAPO_REGISTRATION_PROPERTIES Descrive le caratteristiche generali di un oggetto XAPO. Usato con IXAPO::GetRegistrationProperties, CXAPOParametersBase::CXAPOParametersBase e CXAPOBase::CXAPOBase.
XAUDIO2_BUFFER Rappresenta un buffer di dati audio, usato con IXAudio2SourceVoice::SubmitSourceBuffer.
XAUDIO2_BUFFER_WMA Usato con IXAudio2SourceVoice::SubmitSourceBuffer durante l'invio di dati xWMA.
XAUDIO2_DEBUG_CONFIGURATION Contiene la nuova configurazione di debug globale per XAudio2. Usato con la funzione SetDebugConfiguration.
XAUDIO2_EFFECT_CHAIN Definisce una catena di effetti.
XAUDIO2_EFFECT_DESCRIPTOR Contiene informazioni su un XAPO da usare in una catena di effetti.
XAUDIO2_FILTER_PARAMETERS Definisce i parametri di filtro per una voce di origine.
XAUDIO2_PERFORMANCE_DATA Contiene informazioni sulle prestazioni. (XAUDIO2_PERFORMANCE_DATA)
XAUDIO2_SEND_DESCRIPTOR Definisce una voce di destinazione che è la destinazione di un invio da un'altra voce e specifica se deve essere usato un filtro.
XAUDIO2_VOICE_DETAILS Contiene informazioni sui flag di creazione, sui canali di input e sulla frequenza di esempio di una voce.
XAUDIO2_VOICE_SENDS Definisce un set di voci per ricevere dati da una singola voce di output.
XAUDIO2_VOICE_STATE Restituisce i dati di stato e posizione del cursore correnti della voce.
XAUDIO2FX_REVERB_I3DL2_PARAMETERS Descrive i parametri I3DL2 (Interactive 3D Audio Rendering Guidelines Level 2.0) per l'uso nella funzione ReverbConvertI3DL2ToNative.
XAUDIO2FX_REVERB_PARAMETERS Descrive i parametri da usare nell'APO di riverbero.
XAUDIO2FX_VOLUMEMETER_LEVELS Descrive i parametri da usare con l'APO del contatore del volume.