Metodo IXAudio2Voice::SetEffectChain (xaudio2.h)

Sostituisce la catena di effetti della voce.

Sintassi

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

Parametri

[in, optional] pEffectChain

Puntatore a una struttura XAUDIO2_EFFECT_CHAIN che descrive la nuova catena di effetti da utilizzare. Se viene passato NULL, la catena di effetti corrente viene rimossa.

Nota Se pEffectChain non è NULL, la struttura XAUDIO2_EFFECT_CHAIN a cui punta deve specificare almeno un effetto.

 

Valore restituito

Restituisce S_OK in caso di esito positivo; in caso contrario, un codice di errore.

Per le descrizioni dei codici di errore specifici di XAudio2, vedere Codici di errore XAudio2 .

Commenti

Il numero di canali di output consentiti per la catena di effetti di una voce è bloccato alla creazione della voce. Se crei la voce con una catena di effetti, qualsiasi nuova catena di effetti passata a SetEffectChain deve avere lo stesso numero di canali di input e output della catena di effetti originale. Se si crea la voce senza una catena di effetti, per impostazione predefinita il numero di canali di output consentiti per la catena di effetti sarà il numero di canali di input per la voce. Se una parte della creazione della catena di effetti ha esito negativo, non viene applicata alcuna parte.

Dopo aver collegato un effetto a una voce XAudio2, XAudio2 assume il controllo dell'effetto e il client non deve effettuare ulteriori chiamate. Il modo più semplice per assicurarsi che ciò sia quello di rilasciare tutti i puntatori all'effetto.

Non è possibile chiamare SetEffectChain dall'interno di un callback, ovvero IXAudio2EngineCallback o IXAudio2VoiceCallback. Se chiami SetEffectChain all'interno di un callback, restituisce XAUDIO2_E_INVALID_CALL.

Il XAUDIO2_EFFECT_CHAIN passato come argomento pEffectChain e tutte le informazioni XAUDIO2_EFFECT_DESCRIPTOR contenute al suo interno non sono più necessarie al termine di SetEffectChain e possono essere eliminate immediatamente dopo la chiamata a SetEffectChain .

Requisiti della piattaforma

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

Requisiti

Requisito	Valore
Piattaforma di destinazione	Windows
Intestazione	xaudio2.h

Vedi anche

Procedura: Creare una catena di effetti

IXAudio2Voice

Panoramica di XAPO