IDirectSound3DListener8::GetDistanceFactor Method

  • Article

[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 GetDistanceFactor method retrieves the distance factor, which is the number of meters in a vector unit.

Syntax

HRESULT GetDistanceFactor(
         D3DVALUE * pflDistanceFactor
)

Parameters

  • pflDistanceFactor
    Address of a variable that receives the distance factor value. 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.

Requirements

Header: Declared in DSound.h.

Library: Use Dsound3d.dll.

See Also

IDirectSound3DListener8