| DirectX SDK |
The DirectSoundBuffer.GetPan method retrieves a variable that represents the relative volume between the left and right audio channels.
object.GetPan() As Long
The relative mix between the left and right speakers.
If the method fails, an error is raised and Err.Number may be set to one of the following error codes:
| DSERR_CONTROLUNAVAIL |
| DSERR_INVALIDPARAM |
| DSERR_PRIOLEVELNEEDED |
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 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 for the return value 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.
DirectSoundBuffer, DirectSoundBuffer.GetVolume, DirectSoundBuffer.SetPan, DirectSoundBuffer.SetVolume