Méthode IAudioStreamVolume ::GetChannelVolume (audioclient.h)

La méthode GetChannelVolume récupère le niveau de volume pour le canal spécifié dans le flux audio.

Syntaxe

HRESULT GetChannelVolume(
  [in]  UINT32 dwIndex,
  [out] float  *pfLevel
);

Paramètres

[in] dwIndex

Numéro de canal. Si le format de flux comporte N canaux, les canaux sont numérotés de 0 à N à 1. Pour obtenir le nombre de canaux, appelez la méthode IAudioStreamVolume ::GetChannelCount .

[out] pfLevel

Pointeur vers une variable float dans laquelle la méthode écrit le niveau de volume du canal spécifié. Le niveau de volume se situe entre 0,0 et 1,0.

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 dwIndex est défini sur un numéro de canal non valide.
E_POINTER	Le paramètre pfLevel a la valeur NULL.
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

Les clients peuvent appeler la méthode IAudioStreamVolume ::SetAllVolumes ou IAudioStreamVolume ::SetChannelVolume pour définir les niveaux de volume par canal dans un flux audio.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows Vista [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2008 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	audioclient.h

Voir aussi

IAudioStreamVolume, interface

IAudioStreamVolume ::GetChannelCount

IAudioStreamVolume ::SetAllVolumes

IAudioStreamVolume ::SetChannelVolume