Listener3D.DopplerFactor Property (Microsoft.DirectX.DirectSound)

  • Article

Retrieves or sets the multiplier for the Doppler effect.

Definition

Visual Basic Public Property DopplerFactor As Single
C# public float DopplerFactor { get; set; }
C++ public:
property float DopplerFactor {
        float get();
        void set(float value);
}
JScript public function get DopplerFactor() : float
public function set DopplerFactor(float);

Property Value

System.Single
The multiplier for the Doppler effect.

This property is read/write. 

Remarks

The Doppler factor has a range of 0.0 (no Doppler effects) to 10.0 (ten times the Doppler effects found in the real world). The default value is 1.0.

Exceptions

ArgumentExceptionLeave Site

An invalid parameter was passed to the called method.