Microsoft DirectX 8.1 (C++)

IDirectSoundBuffer8::GetVolume

The GetVolume method retrieves the volume of the buffer.

Syntax

HRESULT GetVolume(
  LPLONG plVolume 
);

Parameters

plVolume

Address of a variable that receives the attenuation, in hundredths of a decibel. See Remarks.

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:

Return code
DSERR_CONTROLUNAVAIL
DSERR_INVALIDPARAM
DSERR_PRIOLEVELNEEDED

Remarks

The return value is between DSBVOLUME_MAX and DSBVOLUME_MIN. 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.

Requirements

  Header: Declared in dsound.h.

See Also