Class AudioEmitter

Namespace

Microsoft.Xna.Framework.Audio

Assembly

MonoGame.Framework.dll

Represents a 3D audio emitter. Used to simulate 3D audio effects.

public class AudioEmitter

Inheritance

object

AudioEmitter

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

AudioEmitter()

Initializes a new AudioEmitter instance.

public AudioEmitter()

Properties

DopplerScale

Gets or sets a scale applied to the Doppler effect between the AudioEmitter and an AudioListener.

public float DopplerScale { get; set; }

Property Value

float

Remarks

Defaults to 1.0

A value of 1.0 leaves the Doppler effect unmodified.

Forward

Gets or sets the emitter's forward vector.

public Vector3 Forward { get; set; }

Property Value

Vector3

Remarks

Defaults to Vector3.Forward. (new Vector3(0, 0, -1))

Used with AudioListener.Velocity to calculate Doppler values.

The Forward and Up values must be orthonormal.

Position

Gets or sets the position of this emitter.

public Vector3 Position { get; set; }

Property Value

Vector3

Up

Gets or sets the emitter's Up vector.

public Vector3 Up { get; set; }

Property Value

Vector3

Remarks

Defaults to Vector3.Up. (new Vector3(0, -1, 1)).

The Up and Forward vectors must be orthonormal.

Velocity

Gets or sets the emitter's velocity vector.

public Vector3 Velocity { get; set; }

Property Value

Vector3

Remarks

Defaults to Vector3.Zero.

This value is only used when calculating Doppler values.