DirectX SDK

DirectSoundBuffer.GetVolume

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

object.GetVolume() As Long

Parameters

object
Object expression that resolves to a DirectSoundBuffer object.

Return Values

The volume associated with the specified DirectSound buffer.

Error Codes

If the method fails, an error is raised and Err.Number may be set to

DSERR_CONTROLUNAVAIL
DSERR_INVALIDPARAM
DSERR_PRIOLEVELNEEDED

Remarks

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

See Also

DirectSoundBuffer, DirectSoundBuffer.SetVolume