Microsoft DirectX 8.1 (Visual Basic)

DirectSound3DListener8.SetDopplerFactor

The SetDopplerFactor method sets the Doppler effect factor.

Syntax

object.SetDopplerFactor( _
  dopplerFactor As Single, _
  applyFlag As CONST_DS3DAPPLYFLAGS)

Parts

object

Resolves to a DirectSound3DListener8 object.

dopplerFactor

Doppler factor value.

applyFlag

Value that specifies when the setting should be applied. Must be one of the constants of the CONST_DS3DAPPLYFLAGS enumeration.

Error Codes

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

Remarks

The Doppler factor has a range of DS3D_MINDOPPLERFACTOR (no Doppler effects) to DS3D_MAXDOPPLERFACTOR (defined as 10 times the Doppler effects found in the real world). The default value is DS3D_DEFAULTDOPPLERFACTOR (1.0).

See Also