Edit

Share via

KSPROPERTY_DIRECTSOUND3DLISTENER_DOPPLERFACTOR

  • Article

The KSPROPERTY_DIRECTSOUND3DLISTENER_DOPPLERFACTOR property specifies the Doppler factor for a 3D listener.

Usage Summary Table

Get Set Target Property descriptor type Property value type

Yes

Yes

Pin

KSNODEPROPERTY

FLOAT

The property value (operation data) is of type FLOAT and specifies the Doppler factor. The Doppler factor can range from DS3D_MINDOPPLERFACTOR to DS3D_MAXDOPPLERFACTOR, which are defined as 0.0 and 10.0 respectively. The default factor is DS3D_DEFAULTDOPPLERFACTOR, which is defined as 1.0.

Return Value

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

Remarks

This property specifies the Doppler factor that is applied to both the 3D listener and 3D sound buffer.

A Doppler factor of zero means that no Doppler shift is applied to a sound regardless of the velocity of the listener or sound buffer. Factors larger than 1 exaggerate the amount of Doppler shift that would occur in the real world.

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

Requirements

Header

 Ksmedia.h (include Ksmedia.h)

See also

KSNODEPROPERTY