IXAudio2Voice::EnableEffect, méthode (xaudio2.h)

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

Syntaxe

\\HRESULT EnableEffect(
  [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 jeux 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.

Remarques

Soyez prudent lorsque vous activez un effet pendant que la voix qui l’héberge est en cours d’exécution. Une telle action peut entraîner un problème si l’effet modifie considérablement la hauteur ou le volume de l’audio.

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 empêcheraient la chaîne d’effets de répondre à ces exigences échoueront.

EnableEffect prend effet immédiatement lorsque vous l’appelez à partir d’un rappel XAudio2 avec un OperationSet de XAUDIO2_COMMIT_NOW.

Configuration requise pour la plateforme

Windows 10 (XAudio2.9); Windows 8, Windows Phone 8 (XAudio 2.8) ; Kit de développement logiciel (SDK) DirectX (XAudio 2.7)

Spécifications

Plateforme cible	Windows
En-tête	xaudio2.h

Voir aussi

IXAudio2Voice

Vue d’ensemble de XAPO