Hardware Dev Center

KSPROPERTY_DIRECTSOUND3DLISTENER_ROLLOFFFACTOR

The KSPROPERTY_DIRECTSOUND3DLISTENER_ROLLOFFFACTOR property specifies the rolloff factor for a 3D listener.

Usage Summary Table

GetSetTargetProperty descriptor typeProperty value type

Yes

Yes

Pin

KSNODEPROPERTY

FLOAT

 

The property value (operation data) is of type FLOAT and specifies the rolloff factor. The rolloff factor can range from DS3D_MINROLLOFFFACTOR to DS3D_MAXROLLOFFFACTOR, which are defined as 0.0 and 10.0 respectively. The default rolloff factor is DS3D_DEFAULTROLLOFFFACTOR, which is defined as 1.0.

Return Value

A KSPROPERTY_DIRECTSOUND3DLISTENER_ROLLOFFFACTOR property request returns STATUS_SUCCESS to indicate that it has completed successfully. Otherwise, the request returns an appropriate error status code.

Remarks

Rolloff is the amount of attenuation that is applied to sounds, based on the listener's distance from the sound source. A rolloff factor of zero means that no attenuation is applied to a sound regardless of its distance from the listener. Factors larger than 1 exaggerate the real-world attenuation of sound with distance.

DirectSound uses this property to implement the IDirectSound3DListener::GetRolloffFactor and IDirectSound3DListener::SetRolloffFactor methods, which are described in the Microsoft Windows SDK documentation.

Requirements

Header

Ksmedia.h (include Ksmedia.h)

See also

KSNODEPROPERTY

 

 

Send comments about this topic to Microsoft

Show:
© 2015 Microsoft