Microsoft DirectX 8.1 (C++)

IBasicAudio::get_Balance

The get_Balance method retrieves the balance for the audio signal.

Syntax

HRESULT get_Balance(
  long *plBalance
);

Parameters

plBalance

[out] Pointer to a variable of type long that receives the balance value.

Return Values

Returns an HRESULT value.

Remarks

The balance is a value between –10,000 and 10,000. A value of –10,000 indicates that the right speaker has been disabled and only the left speaker is receiving an audio signal. A value of 0 indicates that both speakers are receiving equivalent audio signals. A value of 10,000 indicates that the left speaker has been disabled and only the right speaker is receiving an audio signal.

Units correspond to .01 decibels (multiplied by –1 when plBalance is a positive value). For example, a value of 1000 indicates –10 dB on the right channel and –90 dB on the left channel.

See Also