Platform SDK: DirectX

DirectSound3DBuffer.GetMinDistance

The DirectSound3DBuffer.GetMinDistance method retrieves the current minimum distance for this sound buffer, which is the distance at which the sound is at maximum volume.

object.GetMinDistance() As Single

Parameters

object
Object expression that resolves to a DirectSound3DBuffer object.

Return Values

If the method succeeds, the return value is the current minimum distance setting.

Error Codes

If the method fails, an error is raised and Err.Number may be 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.SetMinDistance, DirectSound3DBuffer.GetMaxDistance