Microsoft DirectX 8.1 (C++)

IDirectSound3DListener8::SetDopplerFactor

The SetDopplerFactor method sets the Doppler effect factor.

Syntax

HRESULT SetDopplerFactor(
  D3DVALUE flDopplerFactor, 
  DWORD dwApply 
);

Parameters

flDopplerFactor

Value that specifies the Doppler factor. D3DVALUE is defined as float in D3dtypes.h.

dwApply

Value that specifies when the setting should be applied. This value must be one of the following:

Value Description
DS3D_DEFERRED Settings are not applied until the application calls the IDirectSound3DListener8::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 more information, see Doppler Factor.

Requirements

  Header: Declared in dsound.h.

See Also