DirectSound3DListener.SetDopplerFactor

The DirectSound3DListener.SetDopplerFactor method sets the current Doppler effect factor.

object.SetDopplerFactor(dopplerFactor As Single, _
    applyFlag As CONST_DS3DAPPLYFLAGS)

Parameters

object

Object expression that resolves to a DirectSound3DListener object.

dopplerFactor

New Doppler factor value.

applyFlag

Value indicating when the setting should be applied. This value must be one of the following constants of the CONST_DS3DAPPLYFLAGS enumeration:

DS3D_DEFERRED

Settings are not applied until the application calls the DirectSound3DListener.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.

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.GetDopplerFactor