Méthode ISimpleAudioVolume::SetMute (audioclient.h)

Article
08/22/2023

La méthode SetMute définit l’état de désactivation de la session audio.

Syntaxe

HRESULT SetMute(
  [in] const BOOL bMute,
  [in] LPCGUID    EventContext
);

Paramètres

[in] bMute

Nouvel état de désactivation. TRUE active la désactivation. FALSE désactive le son.

[in] EventContext

Pointeur vers le GUID de contexte d’événement. Si un appel à cette méthode génère un événement de changement de volume, le gestionnaire de session envoie des notifications à tous les clients qui ont inscrit des interfaces IAudioSessionEvents avec le gestionnaire de sessions. Le gestionnaire de sessions inclut la valeur du pointeur EventContext à chaque notification. Lors de la réception d’une notification, un client peut déterminer s’il ou un autre client est la source de l’événement en inspectant la valeur EventContext . Ce schéma dépend du fait que le client sélectionne une valeur pour ce paramètre qui est unique parmi tous les clients de la session. Si l’appelant fournit un pointeur NULL pour ce paramètre, la méthode de notification du client reçoit un pointeur de contexte NULL .

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.

Code de retour	Description
AUDCLNT_E_DEVICE_INVALIDATED	Le périphérique de point de terminaison audio a été débranché, ou le matériel audio ou les ressources matérielles associées ont été reconfigurés, désactivés, supprimés ou autrement rendus indisponibles.
AUDCLNT_E_SERVICE_NOT_RUNNING	Le service audio Windows n’est pas en cours d’exécution.

Notes

Cette méthode génère un événement de modification de volume uniquement si l’appel de méthode modifie l’état de désactivation de la session de désactivé à activé, ou de activé à désactivé. Par exemple, si le son est activé lorsque l’appel se produit et que l’appel active le son, aucun événement n’est généré.

Cette méthode applique le même état de désactivation à tous les canaux de la session audio. L’appareil de point de terminaison applique toujours le son de manière uniforme sur tous les canaux de la session. Il n’existe aucune méthode IChannelAudioVolume pour définir les états de désactivation des canaux individuels.

Le client peut obtenir l’état de désactivation de la session audio en appelant la méthode SimpleAudioVolume::GetMute .

Configuration requise


Client minimal pris en charge	Windows Vista [applications de bureau \| applications UWP]
Serveur minimal pris en charge	Windows Server 2008 [applications de bureau \| applications UWP]
Plateforme cible	Windows
En-tête	audioclient.h

Voir aussi

IAudioSessionEvents, interface

IChannelAudioVolume, interface

ISimpleAudioVolume, interface

ISimpleAudioVolume::GetMute

Partager via