Edit

IBasicAudio::put_Volume method (control.h)

  • Article

[The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, IMFMediaEngine, and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

The put_Volume method sets the volume (amplitude) of the audio signal.

Syntax

HRESULT put_Volume(
  [in] long lVolume
);

Parameters

[in] lVolume

Specifies the volume, as a number from –10,000 to 0, inclusive. Full volume is 0, and –10,000 is silence. Multiply the desired decibel level by 100. For example, –10,000 = –100 dB.

Return value

Returns an HRESULT value. Possible values include the following.

Return code Description
E_FAIL
 The underlying audio device returned an error.
E_INVALIDARG
 The value of lVolume is invalid.
E_NOTIMPL
 The filter graph does not contain an audio renderer filter. (Possibly the source does not contain an audio stream.)
S_OK
 Success.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header control.h (include Dshow.h)
Library Strmiids.lib

See also

Error and Success Codes

IBasicAudio Interface