IDirectSound3DBuffer8::GetMaxDistance Method
[The feature associated with this page, DirectSound, is a legacy feature. It has been superseded by WASAPI and Audio Graphs. Media Casting have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use Media Casting instead of DirectSound, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
The GetMaxDistance method retrieves the maximum distance, which is the distance from the listener beyond which sounds in this buffer are no longer attenuated.
Syntax
HRESULT GetMaxDistance(
D3DVALUE * pflMaxDistance
)
Parameters
- pflMaxDistance
Address of a variable that receives the maximum distance, in meters by default. D3DVALUE is defined as float.
Return Value
If the method succeeds, the return value is DS_OK. If the method fails, the return value may be DSERR_INVALIDPARAM.
Remarks
The default maximum distance, defined as DS3D_DEFAULTMAXDISTANCE, is effectively infinite.
Requirements
Header: Declared in DSound.h.
Library: Use Dsound3d.dll.