Platform SDK: DirectX

DirectSound3DBuffer.GetMaxDistance

The DirectSound3DBuffer.GetMaxDistance method retrieves the current maximum distance for this sound buffer, which is the distance beyond which the volume is no longer attenuated.

object.GetMaxDistance() As Single

Parameters

object
Object expression that resolves to a DirectSound3DBuffer object.

Return Values

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

Error Codes

If the method fails, an error is raised and Err.Number may be set to DSERR_INVALIDPARAM.

Remarks

The default maximum distance, defined as DS3D_DEFAULTMAXDISTANCE, is effectively infinite.

See Also

DirectSound3DBuffer.GetMinDistance, DirectSound3DBuffer.SetMaxDistance