IAudioEndpointVolume::SetChannelVolumeLevel

  • Article
Previous Next

IAudioEndpointVolume::SetChannelVolumeLevel

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

HRESULT SetChannelVolumeLevel(
  UINT  nChannel,
  float  fLevelDB,
  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.

fLevelDB

[in]  The new volume level in decibels. To obtain the range and granularity of the volume levels that can be set by this method, call the IAudioEndpointVolume::GetVolumeRange method.

pguidEventContext

[in]  Context value for the IAudioEndpointVolumeCallback::OnNotify method. This parameter points to an event-context GUID. If the SetChannelVolumeLevel 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 fLevelDB lies outside of the volume range supported by the device.
E_OUTOFMEMORY Out of memory.

Requirements

Client: Windows Vista

Header: Include Endpointvolume.h.

Remarks

If volume level fLevelDB falls outside of the volume range reported by the IAudioEndpointVolume::GetVolumeRange method, the SetChannelVolumeLevel call fails and returns error code E_INVALIDARG.

See Also

Previous Next