IDirectSound3DListener8::GetDopplerFactor Method
[The feature associated with this page, DirectSound, is a legacy feature. It has been superseded by WASAPI and Audio Graphs. Media Casting have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use Media Casting instead of DirectSound, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
The GetDopplerFactor method retrieves the multiplier for the Doppler effect.
Syntax
HRESULT GetDopplerFactor(
D3DVALUE * pflDopplerFactor
)
Parameters
- pflDopplerFactor
Address of a variable that receives the Doppler factor value. D3DVALUE is defined as float.
Return Value
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 (defined as 10 times the Doppler effects found in the real world). The default value is DS3D_DEFAULTDOPPLERFACTOR (1.0).
Requirements
Header: Declared in DSound.h.
Library: Use Dsound3d.dll.