Share via

IChannelAudioVolume::GetChannelVolume

  • Article
Previous Next

IChannelAudioVolume::GetChannelVolume

The GetChannelVolume method retrieves the volume level for the specified channel in the audio session.

HRESULT GetChannelVolume(
  UINT32  dwIndex,
  float  *pfLevel
);

Parameters

dwIndex

[in]  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.

pfLevel

[out]  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
E_INVALIDARG Parameter dwIndex is set to an invalid channel number.
E_POINTER Parameter pfLevel is NULL.
AUDCLNT_E_DEVICE_INVALIDATED 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.
AUDCLNT_E_SERVICE_NOT_RUNNING 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

Client: Windows Vista

Header: Include Audioclient.h.

See Also

Previous Next