Méthode IAudioMeterInformation ::GetChannelsPeakValues (endpointvolume.h)

Article
02/26/2024

La méthode GetChannelsPeakValues obtient les exemples de valeurs de pointe pour tous les canaux du flux audio.

Syntaxe

HRESULT GetChannelsPeakValues(
  [in]  UINT32 u32ChannelCount,
  [out] float  *afPeakValues
);

Paramètres

[in] u32ChannelCount

Nombre de canaux. Ce paramètre spécifie également le nombre d’éléments dans le tableau afPeakValues . Si le nombre spécifié ne correspond pas au nombre de canaux dans le flux, la méthode retourne le code d’erreur E_INVALIDARG.

[out] afPeakValues

Pointeur vers un tableau d’exemples de valeurs de pointe. La méthode écrit les valeurs de pointe des canaux dans le tableau. Le tableau contient un élément pour chaque canal du flux. Les valeurs de pointe sont des nombres dans la plage normalisée comprise 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 u32ChannelCount n’est pas égal au nombre de canaux dans le flux audio.
E_POINTER	Le paramètre afPeakValues a la valeur NULL.

Remarques

Cette méthode récupère les exemples de valeurs de pointe pour les canaux dans le flux. La valeur maximale de chaque canal est enregistrée sur une période d’appareil et mise à disposition au cours de la période d’appareil suivante. Ainsi, cette méthode récupère toujours les valeurs de pointe enregistrées pendant la période précédente de l’appareil. Pour obtenir la période de l’appareil, appelez la méthode IAudioClient ::GetDevicePeriod .

Le paramètre afPeakValues pointe vers un tableau float alloué à l’appelant. Si le flux contient n canaux, les canaux sont numérotés de 0 à n– 1. La méthode stocke la valeur de pointe pour chaque canal de l’élément tableau dont l’index du tableau correspond au numéro de canal. Pour obtenir le nombre de canaux dans le flux audio surveillés par des compteurs de pointe, appelez la méthode IAudioMeterInformation ::GetMeteringChannelCount .

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

IAudioClient ::GetDevicePeriod

IAudioMeterInformation Interface

IAudioMeterInformation ::GetMeteringChannelCount

Partager via