Share via


IMFPMediaPlayer::SetBalance method (mfplay.h)

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

Sets the audio balance.

Syntax

HRESULT SetBalance(
  [in] float flBalance
);

Parameters

[in] flBalance

The audio balance. The value can be any number in the following range (inclusive).

Value Meaning
-1.0
The left channel is at full volume; the right channel is silent.
+1.0
The right channel is at full volume; the left channel is silent.
 

If the value is zero, the left and right channels are at equal volumes. The default value is zero.

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return code Description
S_OK
The method succeeded.
MF_E_OUT_OF_RANGE
The flBalance parameter is invalid.

Remarks

If you call this method before playback starts, the setting is applied when playback starts.

Requirements

Requirement Value
Minimum supported client Windows 7 [desktop apps only]
Minimum supported server Windows Server 2008 R2 [desktop apps only]
Target Platform Windows
Header mfplay.h

See also

IMFPMediaPlayer

Using MFPlay for Audio/Video Playback