| title | description | keywords | topic_type | ms.topic | api_name | api_location | api_type | ms.date | |||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
KSPROPERTY\_DIRECTSOUND3DLISTENER\_DISTANCEFACTOR |
The KSPROPERTY\_DIRECTSOUND3DLISTENER\_DISTANCEFACTOR property specifies the distance factor that should be applied to any distance values. |
|
|
reference |
|
|
|
03/06/2023 |
The KSPROPERTY_DIRECTSOUND3DLISTENER_DISTANCEFACTOR property specifies the distance factor that should be applied to any distance values.
| Get | Set | Target | Property descriptor type | Property value type |
|---|---|---|---|---|
Yes |
Yes |
Pin |
FLOAT |
The property value (operation data) is of type FLOAT and specifies the distance factor.
A KSPROPERTY_DIRECTSOUND3DLISTENER_DISTANCEFACTOR property request returns STATUS_SUCCESS to indicate that it has completed successfully. Otherwise, the request returns an appropriate error status code.
Distances for KSPROPSETID_DirectSound3DBuffer and KSPROPSETID_DirectSound3DListener properties are expressed in units of meters times a distance factor.
By default, the distance factor is 1 and distances are therefore expressed in meters. (Also, the default velocity units are meters per second.)
A client can change the distance units for the KSPROPSETID_DirectSound3DBuffer and KSPROPSETID_DirectSound3DListener properties by sending a KSPROPERTY_DIRECTSOUND3DLISTENER_DISTANCEFACTOR set-property request that specifies a different distance factor.
DirectSound uses this property to implement the IDirectSound3DListener::GetDistanceFactor and IDirectSound3DListener::SetDistanceFactor methods, which are described in the Microsoft Windows SDK documentation.
Header |
Ksmedia.h (include Ksmedia.h) |