IBasicAudio::get_Balance method (control.h)

[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_Balance method retrieves the balance for the audio signal.

Syntax

HRESULT get_Balance(
  [out] long *plBalance
);

Parameters

[out] plBalance

Pointer to a variable that receives the balance.

Return value

Returns an HRESULT value. Possible values include the following.

Remarks

The balance ranges 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.

Requirements

See also

Error and Success Codes

IBasicAudio Interface