Microsoft DirectX 8.0 (Visual Basic)

DirectSoundSecondaryBuffer8.GetVolume

Retrieves the volume for the sound buffer.

object.GetVolume() As Long

Parts

object
Resolves to a DirectSoundSecondaryBuffer8 object.

Return Values

Returns the attenuation of the buffer, in hundredths of a decibel. 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 return value is in the range from DSBVOLUME_MAX through DSBVOLUME_MIN. These constants 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

DirectSoundSecondaryBuffer8.SetVolume, DirectSoundSecondaryBuffer8.GetPan