Méthode IAudioEndpointVolume ::SetChannelVolumeLevelScalar (endpointvolume.h)

Article
03/02/2024

La méthode SetChannelVolumeLevelScalar définit le niveau de volume normalisé et audio-conique du canal spécifié dans le flux audio qui entre ou quitte le périphérique de point de terminaison audio.

Syntaxe

HRESULT SetChannelVolumeLevelScalar(
  [in] UINT    nChannel,
  [in] float   fLevel,
  [in] LPCGUID pguidEventContext
);

Paramètres

[in] nChannel

Numéro de canal. Si le flux audio contient n canaux, les canaux sont numérotés de 0 à n– 1. Pour obtenir le nombre de canaux, appelez la méthode IAudioEndpointVolume ::GetChannelCount .

[in] fLevel

Niveau de volume. Le niveau de volume est exprimé sous la forme d’une valeur normalisée comprise entre 0,0 et 1,0.

[in] pguidEventContext

Valeur de contexte pour la méthode IAudioEndpointVolumeCallback ::OnNotify . Ce paramètre pointe vers un GUID de contexte d’événement. Si l’appel SetChannelVolumeLevelScalar modifie le niveau de volume du point de terminaison, tous les clients qui ont inscrit des interfaces IAudioEndpointVolumeCallback avec ce point de terminaison recevront des notifications. Dans son implémentation de la méthode OnNotify , un client peut inspecter le GUID de contexte d’événement pour découvrir s’il ou un autre client est la source de l’événement de modification de volume. Si l’appelant fournit un pointeur NULL pour ce paramètre, la routine de notification reçoit la valeur GUID de contexte GUID_NULL.

Valeur retournée

Si la méthode réussit, retourne S_OK. Si la méthode échoue, 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 nChannel est supérieur ou égal au nombre de canaux dans le flux ; ou le paramètre fLevel est en dehors de la plage comprise entre 0,0 et 1,0.
E_OUTOFMEMORY	Mémoire insuffisante.

Remarques

Le niveau de volume est normalisé à la plage comprise entre 0,0 et 1,0, où 0,0 est le niveau de volume minimal et 1,0 le niveau maximal. Dans cette plage, la relation entre le niveau de volume normalisé et l’atténuation de l’amplitude du signal est décrite par une courbe audio-conique non linéaire. Notez que la forme de la courbe peut changer dans les versions ultérieures de Windows. Pour plus d’informations sur les courbes audio-coniques, consultez Contrôles de volume audio-conique.

Les niveaux de volume normalisés passés à cette méthode sont adaptés pour représenter les positions des contrôles de volume dans les fenêtres d’application et les écrans visuels.

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	endpointvolume.h

Voir aussi

IAudioEndpointVolume, interface

IAudioEndpointVolume ::GetChannelCount

IAudioEndpointVolumeCallback, interface

IAudioEndpointVolumeCallback ::OnNotify

Share via