Platform SDK: DirectX

DirectSoundBuffer.GetVolume

The DirectSoundBuffer.GetVolume method retrieves the volume for the sound buffer.

object.GetVolume() As Long

Parameters

object
Object expression that resolves to a DirectSoundBuffer object.

Return Values

The method returns the volume of the buffer. See Remarks.

Error Codes

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

Remarks

The volume is specified in hundredths of decibels (dB) of attenuation. Allowable values are between DSBVOLUME_MAX (no attenuation) and DSBVOLUME_MIN (silence). These values are defined as 0 and -10,000, respectively. The value DSBVOLUME_MAX represents the original, unadjusted volume of the sound. The value DSBVOLUME_MIN indicates an audio volume attenuated by 100 dB, which, for practical purposes, is silence.

See Also

DirectSoundBuffer.SetVolume, DirectSoundBuffer.GetPan