Méthode IAudioSessionControl2 ::SetDuckingPreference (audiopolicy.h)

La méthode SetDuckingPreference active ou désactive l’expérience d’atténuation de flux par défaut (auto-ducking) fournie par le système.

Syntaxe

HRESULT SetDuckingPreference(
  [in] BOOL optOut
);

Paramètres

[in] optOut

Variable BOOL qui active ou désactive le canardage automatique du système.

Valeur retournée

Si la méthode réussit, retourne S_OK. En cas d’échec, les codes de retour possibles incluent, sans s’y limiter, les valeurs indiquées dans le tableau suivant.

Remarques

Par défaut, le système ajuste le volume pour tous les sons en cours de lecture lorsque le système démarre une session de communication et reçoit un nouveau flux de communication sur l’appareil de communication par défaut. Pour plus d’informations sur cette fonctionnalité, consultez Utilisation d’un appareil de communication.

Si l’application transmet TRUE dans optOut, le système désactive l’expérience de canardage par défaut. Pour plus d’informations, consultez Désactivation de l’expérience de canardage par défaut.

Pour fournir une implémentation personnalisée, l’application doit recevoir des notifications du système lorsqu’elle ouvre ou ferme le flux de communication. Pour recevoir les notifications, l’application doit appeler cette méthode avant de s’inscrire en appelant IAudioSessionManager2 ::RegisterForDuckNotification. Pour plus d’informations et un exemple de code, consultez Getting Ducking Events.

Si l’application transmet FALSE dans optOut, l’application fournit l’expérience d’atténuation de flux par défaut fournie par le système.

Nous recommandons à l’application d’appeler SetDuckingPreference lors de la création du flux. Toutefois, cette méthode peut être appelée dynamiquement pendant la session pour modifier la préférence initiale.

Configuration requise

Voir aussi

IAudioSessionControl2