IAudioEndpointVolume::SetChannelVolumeLevelScalar

  • Article
Previous Next

IAudioEndpointVolume::SetChannelVolumeLevelScalar

The SetChannelVolumeLevelScalar method sets the normalized, audio-tapered volume level of the specified channel in the audio stream that enters or leaves the audio endpoint device.

HRESULT SetChannelVolumeLevelScalar(
  UINT  nChannel,
  float  fLevel,
  LPCGUID  pguidEventContext
);

Parameters

nChannel

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

fLevel

[in]  The volume level. The volume level is expressed as a normalized value in the range from 0.0 to 1.0.

pguidEventContext

[in]  Context value for the IAudioEndpointVolumeCallback::OnNotify method. This parameter points to an event-context GUID. If the SetChannelVolumeLevelScalar call changes the volume level of the endpoint, all clients that have registered IAudioEndpointVolumeCallback interfaces with that endpoint will receive notifications. In its implementation of the OnNotify method, a client can inspect the event-context GUID to discover whether it or another client is the source of the volume-change event. If the caller supplies a NULL pointer for this parameter, the notification routine receives the context GUID value GUID_NULL.

Return Value

If the method succeeds and the volume level changes, the method returns S_OK. If the method succeeds and the new volume level is the same as the previous volume level, the method returns S_FALSE. If the method 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; or parameter fLevel is outside the range from 0.0 to 1.0.
E_OUTOFMEMORY Out of memory.

Remarks

The volume level is normalized to the range from 0.0 to 1.0, where 0.0 is the minimum volume level and 1.0 is the maximum level. Within this range, the relationship of the normalized volume level to the attenuation of signal amplitude is described by a nonlinear, audio-tapered curve. Note that the shape of the curve might change in future versions of Windows. For more information about audio-tapered curves, see Audio-Tapered Volume Controls.

The normalized volume levels that are passed to this method are suitable to represent the positions of volume controls in application windows and on-screen displays.

Requirements

Client: Windows Vista

Header: Include Endpointvolume.h.

See Also

Previous Next