IAudioEndpointVolume::GetChannelVolumeLevel

  • Article
Previous Next

IAudioEndpointVolume::GetChannelVolumeLevel

The GetChannelVolumeLevel method gets the volume level, in decibels, of the specified channel in the audio stream that enters or leaves the audio endpoint device.

HRESULT GetChannelVolumeLevel(
  UINT  nChannel,
  float  *pfLevelDB
);

Parameters

nChannel

[in]  The channel number. If the audio stream has n channels, the channels are numbered from 0 to n – 1. To obtain the number of channels in the stream, call the IAudioEndpointVolume::GetChannelCount method.

pfLevelDB

[out]  Pointer to a float variable into which the method writes the volume level in decibels. To get the range of volume levels obtained from this method, call the IAudioEndpointVolume::GetVolumeRange method.

Return Value

If the method succeeds, it returns S_OK. If it fails, possible return codes include, but are not limited to, the values shown in the following table.

Return code Description
E_INVALIDARG Parameter nChannel is greater than or equal to the number of channels in the stream.
E_POINTER Parameter pfLevelDB is NULL.

Requirements

Client: Windows Vista

Header: Include Endpointvolume.h.

See Also

Previous Next