IDirectSoundBuffer::GetPan
This method retrieves a variable that represents the relative volume between the left and right audio channels.
HRESULT GetPan(
LPLONG lplPan
);
Parameters
- lplPan
Address of a variable to contain the relative mix between the left and right speakers.
Return Values
If the method succeeds, the return value is DS_OK.
If the method fails, the return value may be one of the following error values:
DSERR_CONTROLUNAVAIL |
DSERR_INVALIDPARAM |
DSERR_PRIOLEVELNEEDED |
Remarks
The returned value is measured in hundredths of a decibel (dB), in the range of DSBPAN_LEFT to DSBPAN_RIGHT. These values are currently defined in Dsound.h as -10,000 and 10,000 respectively. The value DSBPAN_LEFT means the right channel is attenuated by 100 dB. The value DSBPAN_RIGHT means the left channel is attenuated by 100 dB. The neutral value is DSBPAN_CENTER, defined as zero. This value of 0 in the lplPan parameter means that both channels are at full volume (they are attenuated by 0 decibels). At any setting other than DSBPAN_CENTER, one of the channels is at full volume and the other is attenuated.
A pan of -2173 means that the left channel is at full volume and the right channel is attenuated by 21.73 dB. Similarly, a pan of 870 means that the left channel is attenuated by 8.7 dB and the right channel is at full volume. A pan of DSBPAN_LEFT means that the right channel is silent and the sound is all the way to the left, while a pan of DSBPAN_RIGHT means that the left channel is silent and the sound is all the way to the right.
The pan control acts cumulatively with the volume control.
Requirements
OS Versions: Windows CE 2.12 and later. Version 2.12 requires DXPAK 1.0 or later.
Header: Dsound.h.
Link Library: Dsound.lib.
See Also
IDirectSoundBuffer | IDirectSoundBuffer::GetVolume | IDirectSoundBuffer::SetPan | IDirectSoundBuffer::SetVolume
Last updated on Thursday, April 08, 2004
© 1992-2003 Microsoft Corporation. All rights reserved.