IXAudio2Voice ::D isableEffect, méthode (xaudio2.h)

Désactive l’effet à une position donnée dans la chaîne d’effets de la voix.

Syntaxe

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

Paramètres

[in] EffectIndex

Index de base zéro d’un effet dans la chaîne d’effets de la voix.

[in] OperationSet

Identifie cet appel dans le cadre d’un lot différé. Pour plus d’informations, consultez vue d’ensemble des ensembles d’opérations XAudio2 .

Valeur retournée

Retourne S_OK en cas de réussite ; sinon, un code d’erreur. Consultez Codes d’erreur XAudio2 pour obtenir une description des codes d’erreur valides.

Remarques

Les effets dans la chaîne d’effets d’une voix XAudio2 donnée doivent consommer et produire de l’audio au taux d’échantillonnage de traitement de cette voix. Le seul aspect du format audio qu’ils peuvent modifier est le nombre de canaux. Par exemple, un effet de réverbération peut convertir des données mono en 5.1. Le client peut utiliser le champ OutputChannels de la structure XAUDIO2_EFFECT_DESCRIPTOR pour spécifier le nombre de canaux qu’il souhaite que chaque effet produise. Chaque effet d’une chaîne d’effets doit produire un certain nombre de canaux que l’effet suivant peut consommer. Tous les appels à IXAudio2Voice ::EnableEffect ou IXAudio2Voice ::D isableEffect qui feraient en sorte que la chaîne d’effets cesse de remplir ces exigences échoue.

La désactivation d’un effet le supprime immédiatement du graphique de traitement. Tout audio en attente dans l’effet, tel qu’une queue de réverbération, n’est pas lu. Veillez à désactiver un effet pendant que la voix qui l’héberge est en cours d’exécution. Cela peut entraîner un artefact audible si l’effet modifie considérablement la hauteur ou le volume de l’audio.

DisableEffect prend effet immédiatement lorsqu’il est appelé à partir d’un rappel XAudio2 avec un OperationSet de XAUDIO2_COMMIT_NOW.

Configuration requise pour la plateforme

Configuration requise

Voir aussi

IXAudio2Voice

Vue d’ensemble de XAPO