IChannelAudioVolume::GetChannelVolume method (audioclient.h)
The GetChannelVolume method retrieves the volume level for the specified channel in the audio session.
Syntax
HRESULT GetChannelVolume(
[in] UINT32 dwIndex,
[out] float *pfLevel
);
Parameters
[in] dwIndex
The channel number. If the stream format for the audio session has N channels, then the channels are numbered from 0 to N– 1. To get the number of channels, call the IChannelAudioVolume::GetChannelCount method.
[out] pfLevel
Pointer to a float variable into which the method writes the volume level of the specified channel. The volume level is in the range 0.0 to 1.0.
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 |
|---|---|
|
Parameter dwIndex is set to an invalid channel number. |
|
Parameter pfLevel is NULL. |
|
The audio endpoint device has been unplugged, or the audio hardware or associated hardware resources have been reconfigured, disabled, removed, or otherwise made unavailable for use. |
|
The Windows audio service is not running. |
Remarks
Clients can call the IChannelAudioVolume::SetAllVolumes or IChannelAudioVolume::SetChannelVolume method to set the per-channel volume levels in an audio session.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows Vista [desktop apps only] |
| Minimum supported server | Windows Server 2008 [desktop apps only] |
| Target Platform | Windows |
| Header | audioclient.h |
See also
IChannelAudioVolume::GetChannelCount