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

Article
08/22/2023

La méthode SetMasterVolume définit le niveau de volume master pour la session audio.

Syntaxe

HRESULT SetMasterVolume(
  [in] float   fLevel,
  [in] LPCGUID EventContext
);

Paramètres

[in] fLevel

La nouvelle master niveau de volume. Les niveaux de volume valides sont comprises entre 0,0 et 1,0.

[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
E_INVALIDARG	Le paramètre fLevel n’est pas dans la plage 0.0 à 1.0.
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.

Remarques

Cette méthode génère un événement de modification de volume uniquement si l’appel de méthode modifie le niveau de volume de la session. Par exemple, si le niveau de volume est 0,4 lorsque l’appel se produit et que l’appel définit le niveau de volume sur 0,4, aucun événement n’est généré.

Configuration requise

Condition requise	Valeur
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

ISimpleAudioVolume, interface

ISimpleAudioVolume ::GetMasterVolume

Share via