DirectSound3DListener.GetDopplerFactor

The DirectSound3DListener.GetDopplerFactor method retrieves the current Doppler effect factor.

object.GetDopplerFactor() As Single

Parameters

object

Object expression that resolves to a DirectSound3DListener object.

Return Values

If the method succeeds, the current Doppler factor value is returned.

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 (as currently defined, 10 times the Doppler effects found in the real world). The default value is DS3D_DEFAULTDOPPLERFACTOR (1.0).

See Also

DirectSound3DListener.SetDopplerFactor