SoundEffect.DopplerScale Property

  • Article

Gets or sets a value that adjusts the effect of doppler calculations on the sound (emitter).

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

Syntax

public static float DopplerScale { get; set; }

Property Value

Value that scales doppler calculations on the sound (emitter).

Remarks

DopplerScale changes the relative velocities of emitters and listeners.

If sounds are shifting (pitch) too much for the given relative velocity of the emitter and listener, decrease the DopplerScale. If sounds are not shifting enough for the given relative velocity of the emitter and listener, increase the DopplerScale.

Adjustment Effect
DopplerScale = 0 No Doppler will be applied
0.0 < DopplerScale <= 1.0 Decreases the effect of Doppler
DopplerScale = 1.0 No scaling (default)
DopplerScale > 1.0 Increase the effect of Doppler

See Also

Reference

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

Platforms

Xbox 360, Windows 7, Windows Vista, Windows XP, Windows Phone