AudioEmitterProcessor Class

    Namespace: Stride.Audio
    Assembly: Stride.Engine.dll

    Processor in charge of updating the AudioEmitterComponents.

    System.Object → EntityProcessor → EntityProcessor<AudioEmitterComponent, AudioEmitterProcessor.AssociatedData> → AudioEmitterProcessor
    Derived from AudioEmitterProcessor: 

    public class AudioEmitterProcessor : EntityProcessor<AudioEmitterComponent, AudioEmitterProcessor.AssociatedData>
    Remarks

    More precisely it updates the AudioEmitters and then applies 3D localization to each couple AudioEmitterComponent-AudioListenerComponent. When a new emitter or a new listener is added to the system, its creates the required SoundInstances and associate them with the new emitter/listener tuples.

    Name Description
    Constructors
    AudioEmitterProcessor()

    Create a new instance of the processor.
    Methods
    Draw(RenderContext)
    GenerateComponentData(Entity, AudioEmitterComponent)
    IsAssociatedDataValid(Entity, AudioEmitterComponent, AudioEmitterProcessor.AssociatedData)
    OnEntityComponentAdding(Entity, AudioEmitterComponent, AudioEmitterProcessor.AssociatedData)
    OnEntityComponentRemoved(Entity, AudioEmitterComponent, AudioEmitterProcessor.AssociatedData)
    OnSystemAdd()
    OnSystemRemove()
    | Improve this Doc View Source

    Constructors

    AudioEmitterProcessor()

    Create a new instance of the processor.

    public AudioEmitterProcessor()
    | Improve this Doc View Source

    Methods

    Draw(RenderContext)

    public override void Draw(RenderContext context)
    Parameters
    Type Name Description
    RenderContext context
    Overrides

    GenerateComponentData(Entity, AudioEmitterComponent)

    protected override AudioEmitterProcessor.AssociatedData GenerateComponentData(Entity entity, AudioEmitterComponent component)
    Parameters
    Type Name Description
    Entity entity
    AudioEmitterComponent component
    Returns
    Type Description
    AudioEmitterProcessor.AssociatedData
    Overrides
    Stride.Engine.EntityProcessor<Stride.Engine.AudioEmitterComponent, Stride.Audio.AudioEmitterProcessor.AssociatedData>.GenerateComponentData(Stride.Engine.Entity, Stride.Engine.AudioEmitterComponent)

    IsAssociatedDataValid(Entity, AudioEmitterComponent, AudioEmitterProcessor.AssociatedData)

    protected override bool IsAssociatedDataValid(Entity entity, AudioEmitterComponent component, AudioEmitterProcessor.AssociatedData associatedData)
    Parameters
    Type Name Description
    Entity entity
    AudioEmitterComponent component
    AudioEmitterProcessor.AssociatedData associatedData
    Returns
    Type Description
    System.Boolean
    Overrides
    Stride.Engine.EntityProcessor<Stride.Engine.AudioEmitterComponent, Stride.Audio.AudioEmitterProcessor.AssociatedData>.IsAssociatedDataValid(Stride.Engine.Entity, Stride.Engine.AudioEmitterComponent, Stride.Audio.AudioEmitterProcessor.AssociatedData)

    OnEntityComponentAdding(Entity, AudioEmitterComponent, AudioEmitterProcessor.AssociatedData)

    protected override void OnEntityComponentAdding(Entity entity, AudioEmitterComponent component, AudioEmitterProcessor.AssociatedData data)
    Parameters
    Type Name Description
    Entity entity
    AudioEmitterComponent component
    AudioEmitterProcessor.AssociatedData data
    Overrides
    Stride.Engine.EntityProcessor<Stride.Engine.AudioEmitterComponent, Stride.Audio.AudioEmitterProcessor.AssociatedData>.OnEntityComponentAdding(Stride.Engine.Entity, Stride.Engine.AudioEmitterComponent, Stride.Audio.AudioEmitterProcessor.AssociatedData)

    OnEntityComponentRemoved(Entity, AudioEmitterComponent, AudioEmitterProcessor.AssociatedData)

    protected override void OnEntityComponentRemoved(Entity entity, AudioEmitterComponent component, AudioEmitterProcessor.AssociatedData data)
    Parameters
    Type Name Description
    Entity entity
    AudioEmitterComponent component
    AudioEmitterProcessor.AssociatedData data
    Overrides
    Stride.Engine.EntityProcessor<Stride.Engine.AudioEmitterComponent, Stride.Audio.AudioEmitterProcessor.AssociatedData>.OnEntityComponentRemoved(Stride.Engine.Entity, Stride.Engine.AudioEmitterComponent, Stride.Audio.AudioEmitterProcessor.AssociatedData)

    OnSystemAdd()

    protected override void OnSystemAdd()
    Overrides
    Stride.Engine.EntityProcessor<Stride.Engine.AudioEmitterComponent, Stride.Audio.AudioEmitterProcessor.AssociatedData>.OnSystemAdd()

    OnSystemRemove()

    protected override void OnSystemRemove()
    Overrides
    Stride.Engine.EntityProcessor<Stride.Engine.AudioEmitterComponent, Stride.Audio.AudioEmitterProcessor.AssociatedData>.OnSystemRemove()

    Inherited Members

    Extension Methods