Edit

IBasicAudio::get_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 get_Volume method retrieves the volume (amplitude) of the audio signal.

Syntax

HRESULT get_Volume(
  [out] long *plVolume
);

Parameters

[out] plVolume

Pointer to a variable that receive the volume. Divide by 100 to get equivalent decibel value. For example, –10,000 is –100 dB.

Return value

Returns an HRESULT value. Possible values include the following.

Return code Description
E_NOTIMPL
 The filter graph does not contain an audio renderer filter. (Possibly the source does not contain an audio stream.)
E_POINTER
 NULL pointer argument.
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