Windows hardware
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

IAudioEndpointVolume::GetChannelVolumeLevel method

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.

Syntax


HRESULT GetChannelVolumeLevel(
  [in]  UINT  nChannel,
  [out] 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 codeDescription
E_INVALIDARG

Parameter nChannel is greater than or equal to the number of channels in the stream.

E_POINTER

Parameter pfLevelDB is NULL.

 

Requirements

Minimum supported client

Windows Vista [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2008 [desktop apps | Windows Store apps]

Header

Endpointvolume.h

See also

IAudioEndpointVolume Interface
IAudioEndpointVolume::GetChannelCount
IAudioEndpointVolume::GetVolumeRange

 

 

Community Additions

Show:
© 2016 Microsoft