IDirectSound3DListener::SetDopplerFactor
The IDirectSound3DListener::SetDopplerFactor method sets the current Doppler effect factor.
HRESULT SetDopplerFactor(
D3DVALUE flDopplerFactor,
DWORD dwApply
);
Parameters
flDopplerFactor
New Doppler factor value.
dwApply
Value indicating when the setting should be applied. This value must be one of the following:
| DS3D_DEFERRED | Settings are not applied until the application calls the IDirectSound3DListener::CommitDeferredSettings method. This allows the application to change several settings and generate a single recalculation. |
| DS3D_IMMEDIATE | Settings are applied immediately, causing the system to recalculate the 3-D coordinates for all 3-D sound buffers. |
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.
QuickInfo
Windows NT: Use version 5.0 or later.
Windows: Use Windows 95 OSR2 or later. Available as a redistributable for Windows 95.
Windows CE: Unsupported.
Header: Declared in dsound.h.
Import Library: Use dsound.lib.
See Also