Search Results for

    Show / Hide Table of Contents

    Class AudioEmitter

    Represents a 3D audio emitter in the 3D world. This object, used in combination with an AudioListener, can simulate 3D audio localization effects for a given sound. For more details take a look at the Apply3D(AudioEmitter) function.

    Inheritance
    object
    AudioEmitter
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Evergine.Common.Audio
    Assembly: Evergine.Common.dll
    Syntax
    public class AudioEmitter

    Constructors

    AudioEmitter()

    Initializes a new instance of the AudioEmitter class.

    Declaration
    public AudioEmitter()
    See Also
    Apply3D(AudioEmitter)
    AudioListener

    Fields

    Velocity

    The sound emitter velocity in the 3D world.

    Declaration
    public Vector3 Velocity
    Field Value
    Type Description
    Vector3
    Remarks

    This is only used to calculate the doppler effect on the sound effect.

    See Also
    Apply3D(AudioEmitter)
    AudioListener

    WorldTransform

    The world transform of the sound emitter in the 3D world.

    Declaration
    public Matrix4x4 WorldTransform
    Field Value
    Type Description
    Matrix4x4
    See Also
    Apply3D(AudioEmitter)
    AudioListener

    Properties

    ConeInnerAngle

    Gets or sets the inner cone angle in radians. This value must be within 0.0f to TwoPi.

    Declaration
    public float ConeInnerAngle { get; set; }
    Property Value
    Type Description
    float
    See Also
    Apply3D(AudioEmitter)
    AudioListener

    ConeOuterAngle

    Gets or sets the outer cone angle in radians. This value must be within ConeInnerAngle to TwoPi.

    Declaration
    public float ConeOuterAngle { get; set; }
    Property Value
    Type Description
    float
    See Also
    Apply3D(AudioEmitter)
    AudioListener

    ConeOuterVolume

    Gets or sets the volume scaler on/beyond outer cone. This value must be within 0.0f to 1.0f.

    Declaration
    public float ConeOuterVolume { get; set; }
    Property Value
    Type Description
    float
    See Also
    Apply3D(AudioEmitter)
    AudioListener

    DistanceScaleFactor

    Gets or sets the distance scale factor of the emitter.

    Declaration
    public float DistanceScaleFactor { get; set; }
    Property Value
    Type Description
    float
    See Also
    Apply3D(AudioEmitter)
    AudioListener

    Extension Methods

    ReflectionHelper.GetMemberAssembly(object)
    ReflectionHelper.GetTypeName(object)

    See Also

    Apply3D(AudioEmitter)
    AudioListener
    In This Article
    Back to top
    Generated by DocFX