IDirectSound3DListener::GetDopplerFactor

The IDirectSound3DListener::GetDopplerFactor method retrieves the current Doppler effect factor.

HRESULT GetDopplerFactor(

LPD3DVALUE lpflDopplerFactor

);

Parameters
lpflDopplerFactor
Address of a variable whose type is D3DVALUE and that will contain the current Doppler factor value.
Return Values

If the method succeeds, the return value is DS_OK.

If the method fails, the return value may be 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). For additional information, see Doppler Factor.

See Also

IDirectSound3DListener::SetDopplerFactor