Class AudioListenerComponent

Namespace

Stride.Engine

Assembly

Stride.Engine.dll

Component representing an audio listener.

[Display("Audio listener", null, Expand = ExpandRule.Once)]
[DataContract("AudioListenerComponent")]
[DefaultEntityComponentProcessor(typeof(AudioListenerProcessor), ExecutionMode = ExecutionMode.Runtime)]
[ComponentOrder(6000)]
[ComponentCategory("Audio")]
public sealed class AudioListenerComponent : ActivableEntityComponent, IIdentifiable

Inheritance

object

EntityComponent

ActivableEntityComponent

AudioListenerComponent

Implements

IIdentifiable

Inherited Members

ActivableEntityComponent.Enabled

EntityComponent.Entity

EntityComponent.Id

Remarks

Associate this component to an Entity to simulate a physical listener listening to the AudioEmitterComponents of the scene, placed at the entity's center and oriented along the entity's Oz (forward) and Oy (up) vectors.

Use the AudioSystem's `AudioSystem.AddListener` and `AudioSystem.RemoveListener` functions to activate/deactivate the listeners that are actually listening at a given time.

The entity needs to be added to the Entity System so that the associated AudioListenerComponent can be processed.