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

La méthode GetVolumeStepInfo obtient des informations sur l’étape actuelle dans la plage de volumes.

Syntaxe

HRESULT GetVolumeStepInfo(
  [out] UINT *pnStep,
  [out] UINT *pnStepCount
);

Paramètres

[out] pnStep

Pointeur vers une variable UINT dans laquelle la méthode écrit l’index d’étape actuel. Cet index est une valeur comprise entre 0 et *pStepCount– 1, où 0 représente le niveau de volume minimal et *pStepCount– 1 représente le niveau maximal.

[out] pnStepCount

Pointeur vers une variable UINT dans laquelle la méthode écrit le nombre d’étapes dans la plage de volumes. Ce nombre reste constant pendant la durée de vie de l’interface IAudioEndpointVolume instance.

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

Cette méthode représente le niveau de volume du flux audio qui entre ou quitte le périphérique de point de terminaison audio en tant qu’index ou « étape » dans une plage de niveaux de volume discrets. La valeur de sortie *pnStepCount est le nombre d’étapes dans la plage. La valeur de sortie *pnStep est l’index d’étape du niveau de volume actuel. Si le nombre d’étapes est n = *pnStepCount, l’index d’étape *pnStep peut supposer des valeurs comprises entre 0 (volume minimal) et n – 1 (volume maximal).

Sur la plage comprise entre 0 et n – 1, les intervalles successifs entre les étapes adjacentes ne représentent pas nécessairement des incréments de volume uniformes en amplitude de signal linéaire ou en décibels. Dans Windows Vista, GetVolumeStepInfo définit la relation entre l’index et le niveau de volume (amplitude du signal) comme une courbe conique audio. 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 applications audio peuvent appeler les méthodes IAudioEndpointVolume ::VolumeStepUp et IAudioEndpointVolume ::VolumeStepDown pour augmenter ou diminuer le niveau de volume d’un intervalle. L’une ou l’autre méthode calcule d’abord le niveau de volume idéalisé qui correspond au point suivant sur la courbe audio-conique. Ensuite, la méthode sélectionne le paramètre de volume de point de terminaison qui est la meilleure approximation du niveau idéalisé. Pour obtenir la plage et la granularité des paramètres de volume de point de terminaison, appelez la méthode IEndpointVolume ::GetVolumeRange . Si le périphérique de point de terminaison audio implémente un contrôle de volume matériel, GetVolumeRange décrit les paramètres du volume matériel. Sinon, l’API EndpointVolume implémente le contrôle du volume de point de terminaison dans le logiciel, et GetVolumeRange décrit les paramètres de volume du contrôle implémenté par logiciel.

Configuration requise

Voir aussi

IAudioEndpointVolume, interface

IAudioEndpointVolume ::VolumeStepDown

IAudioEndpointVolume ::VolumeStepUp