AudioEmitter.DopplerScale Property

  • Article

Gets or sets a scalar applied to the level of Doppler effect calculated between this and any AudioListener.

Namespace: Microsoft.Xna.Framework.Audio
Assembly: Microsoft.Xna.Framework (in microsoft.xna.framework.dll)

Syntax

public float DopplerScale { get; set; }

Property Value

The Doppler scale value.

Remarks

By default, this value is 1.0.

This value determines how much to modify the calculated Doppler effect between this object and a AudioListener. Values below 1.0 scale down the Doppler effect to make it less apparent. Values above 1.0 exaggerate the Doppler effect. A value of 1.0 leaves the effect unmodified.

Note that this value modifies only the calculated Doppler between this object and a AudioListener. The calculated Doppler is a product of the relationship between AudioEmitter.Velocity and AudioListener.Velocity. If the calculation yields a result of no Doppler effect, this value has no effect.

See Also

Reference

AudioEmitter Class
AudioEmitter Members
Microsoft.Xna.Framework.Audio Namespace

Platforms

Xbox 360, Windows XP SP2, Windows Vista