Microsoft DirectX 9.0

IDirectSoundBuffer8::SetVolume

The SetVolume method sets the attenuation of the sound.

Syntax

HRESULT SetVolume(
  LONG lVolume 
);

Parameters

lVolume

Attenuation, in hundredths of a decibel (dB).

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_GENERIC
DSERR_INVALIDPARAM
DSERR_PRIOLEVELNEEDED

Remarks

Allowable values are between DSBVOLUME_MAX (no attenuation) and DSBVOLUME_MIN (silence). These values are defined in Dsound.h 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. DirectSound does not support amplification.

Requirements

  Header: Declared in dsound.h.

See Also