DirectSound3DBuffer.SetMinDistance

The DirectSound3DBuffer.SetMinDistance method sets the current minimum distance value.

object.SetMinDistance(minDistance As Single, _
    applyFlag As CONST_DS3DAPPLYFLAGS)

Parameters

object

Object expression that resolves to a DirectSound3DBuffer object.

minDistance

New minimum distance 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

By default, the minimum distance value is DS3D_DEFAULTMINDISTANCE, currently defined as 1.0 (corresponding to 1.0 meter at the default distance factor of 1.0 meters per unit).

See Also

DirectSound3DBuffer.SetMaxDistance