DirectSound3DListener.SetDistanceFactor

The DirectSound3DListener.SetDistanceFactor method sets the current distance factor.

object.SetDistanceFactor(distanceFactor As Single, _
    applyFlag As CONST_DS3DAPPLYFLAGS)

Parameters

object

Object expression that resolves to a DirectSound3DListener object.

distanceFactor

New distance factor.

applyFlag

Value indicating when the setting should be applied. This value must be one of the following flags 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

For additional information about distance factors, see Distance Factor.

See Also

DirectSound3DListener.GetDistanceFactor