Edit

IBasicAudio::put_Balance 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_Balance method sets the balance of the audio signal.

Syntax

HRESULT put_Balance(
  [in] long lBalance
);

Parameters

[in] lBalance

Specifies the balance. The value can range from -10,000 to 10,000. The value -10,000 means the right channel is attenuated by 100 dB and is effectively silent. The value 10,000 means the left channel is silent. The neutral value is 0, which means that both channels are at full volume. When one channel is attenuated, the other remains at full volume.

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 lBalance 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